Card Fraud Outreach
Card Fraud Outreach is a customizable way to help your end-customers confirm or report suspicious card transactions.
When suspicious card activity is identified, you can programmatically notify your customers by sending them branded messages. These messages enable your customers to confirm or report any suspicious transactions.
Card Fraud Outreach is a part of our card fraud monitoring Card Fraud Monitoring experience. It substitutes communication done by Visa.
Card Fraud Case
When an authorization or transaction receives a Decline
status with a SuspectedFraud
reason (Authorization, Card Fraud Monitoring - Transaction Lifecycle, Card Fraud Monitoring - Visa Transaction Scoring), a Fraud Case is automatically created.
Each Fraud Case (Transaction / Authorization) is linked to a suspicious transaction and requires customer feedback for resolution within a specified timeframe, typically 72 hours.
This timeframe, referred to as the Fraud Case expiration period, is a customizable parameter (caseExpirationPeriodHours
) defined by the Client within their Fraud Outreach Policy.
If no Customer feedback is received, the Fraud Case expires and cannot be acted upon.
Get Card Fraud Case by Id
Get a card fraud case by id.
Verb | GET |
Url | https://api.s.unit.sh/card-fraud-cases/{id} |
Timeout (Seconds) | 5 |
curl -X GET 'https://api.s.unit.sh/card-fraud-cases/1' \
-H "Authorization: Bearer ${TOKEN}"
Response
Response is a JSON:API document.
200 OK
Field | Type | Description |
---|---|---|
data | Authorization Card Fraud Case or Transaction Card Fraud Case | Card Fraud Case resource. Can be either Authorization or Transaction as indicated by the type field. |
List Card Fraud Cases
List card fraud case resources. Paging can be applied.
Verb | GET |
Url | https://api.s.unit.sh/card-fraud-cases |
Timeout (Seconds) | 5 |
Query Parameters
Field | Type | Default | Description |
---|---|---|---|
page[limit] | integer | 100 | Optional. Maximum number of resources that will be returned. Maximum is 10000 resources. See Pagination. |
page[offset] | integer | 0 | Optional. Number of resources to skip. See Pagination. |
filter[cardId] | string | (empty) | Optional. Filter by card id. |
filter[accountId] | string | (empty) | Optional. Filter by account id. |
filter[customerId] | string | (empty) | Optional. Filter by customer id. |
filter[status][] | string | (empty) | Optional. Filter by case status. Can be one of the following values: Created , Active , Closed , Expired . |
filter[decision][] | string | (empty) | Optional. Filter by case decision. Can be one of the following values: Pending , Fraud , NoFraud . |
sort | string | sort=-createdAt | Optional. sort=createdAt for ascending order or sort=-createdAt (leading minus sign) for descending order. |
curl -X GET 'https://api.s.unit.sh/card-fraud-cases?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"
Response
Response is a JSON:API document.
200 OK
Field | Type | Description |
---|---|---|
data | Array of Authorization Card Fraud Case or Transaction Card Fraud Case | Array of card fraud case resources. Each resource can be either Transaction or Authorization , as indicated by the type field. |
meta | JSON object that contains pagination data | Pagination data includes offset, limit and total (estimated total items). |
{
"data": [
{
"type": "authorizationCardFraudCase",
"id": "9",
"attributes": {
"createdAt": "2024-07-31T11:02:27.355Z",
"status": "Closed",
"decision": "Fraud",
"expiresAt": "2024-08-03T11:02:27.355Z",
"cardActivities": [
{
"id": "15",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-31T11:02:27.270Z",
"cardActivity": "8082294",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 2500,
"decision": "Fraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "16",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-30T14:40:13.147Z",
"cardActivity": "8069211",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "17",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Transaction",
"cardActivityCreatedAt": "2024-07-30T14:40:07.534Z",
"cardActivity": "8069210",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
}
],
"updatedAt": "2024-07-31T11:04:43.696Z"
},
"relationships": {
"card": {
"data": {
"type": "card",
"id": "2200412"
}
},
"account": {
"data": {
"type": "account",
"id": "49230"
}
},
"customer": {
"data": {
"type": "customer",
"id": "49430"
}
},
"authorization": {
"data": {
"type": "authorization",
"id": "8082294"
}
}
}
},
{
"type": "transactionCardFraudCase",
"id": "10",
"attributes": {
"createdAt": "2024-07-31T11:02:27.355Z",
"status": "Closed",
"decision": "NoFraud",
"expiresAt": "2024-08-03T11:02:27.355Z",
"cardActivities": [
{
"id": "20",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-31T11:02:27.270Z",
"cardActivity": "8082294",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 2500,
"decision": "Fraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "21",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-30T14:40:13.147Z",
"cardActivity": "8069211",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "22",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Transaction",
"cardActivityCreatedAt": "2024-07-30T14:40:07.534Z",
"cardActivity": "8069210",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
}
],
"updatedAt": "2024-07-31T11:04:43.696Z"
},
"relationships": {
"card": {
"data": {
"type": "card",
"id": "2200412"
}
},
"account": {
"data": {
"type": "account",
"id": "49230"
}
},
"customer": {
"data": {
"type": "customer",
"id": "49430"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "8069210"
}
}
}
}
],
"meta": {
"pagination": {
"total": 1,
"limit": 100,
"offset": 0
}
}
}
Card Fraud Outreach Policy
Prior to utilizing the card fraud outreach, clients must configure key parameters governing Fraud Case management and customer communication. The card fraud outreach policy is designated to set the rules, configurations and customizations needed for the card fraud outreach process.
Create Policy
Verb | POST |
Url | https://api.s.unit.sh/fraud-outreach-policies |
Data Type | cardFraudOutreachPolicy |
Timeout (Seconds) | 5 |
Attributes
Field | type | Default | Description |
---|---|---|---|
contactPhone | Phone | (empty) | The client support contact phone number. |
contactUrl | string | (empty) | The client support contact URL. Should be a valid https URL. |
activitiesLookBackPeriodHours | integer | 72 | Optional. The period in hours before the card fraud case was created, for which the card fraud case activities will be included in the case. Can be one of the following periods: 12, 24, 48, 72 |
caseExpirationPeriodHours | integer | 72 | Optional. The period in hours after the card fraud case was created, after which the card fraud case expires. Can be one of the following periods: 12, 24, 48, 72 |
numberOfActivities | integer | 3 | Optional. The number of card activities that will be included in the card fraud case. Up to 5 activities max. |
idempotencyKey | string | (empty) | Optional. See Idempotency. |
Relationships
Field | type | Description |
---|---|---|
whiteLabelTheme | JSON:API Relationship | The white-label theme to be used for the policy. See White-Label Theme. |
emailOutreachSettings | JSON:API Relationship | Optional. The email outreach settings to be used for the policy. |
messageOutreachSettings | JSON:API Relationship | Optional. The message outreach settings to be used for the policy. |
curl -X POST 'https://api.s.unit.sh/fraud-outreach-policies'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "cardFraudOutreachPolicy",
"attributes": {
"caseExpirationPeriodHours": 72,
"activitiesLookBackPeriodHours": 72,
"contactUrl": "https://thisIsMyDomain.unit.co",
"contactPhone": {
"countryCode": "213",
"number": "5350405030"
},
"numberOfCardActivities": 3
},
"relationships": {
"emailOutreachSettings": {
"data": {
"type": "emailOutreachSettings",
"id": "10001"
}
},
"messageOutreachSettings": {
"data": {
"type": "messageOutreachSettings",
"id": "10002"
}
},
"whiteLabelTheme": {
"data": {
"type": "whiteLabelTheme",
"id": "10005"
}
}
}
}
}'
Response
Response is a JSON:API document.
201 Created
Field | Type | Description |
---|---|---|
data | CardFraudOutreachPolicy | The created CardFraudOutreachPolicy resource. |
{
"data": {
"type": "cardFraudOutreachPolicy",
"id": "1",
"attributes": {
"createdAt": "2024-07-30T14:29:29.986Z",
"activitiesLookBackPeriodHours": 72,
"caseExpirationPeriodHours": 72,
"numberOfActivities": 3,
"contactPhone": {
"countryCode": "213",
"number": "5350405030"
},
"contactUrl": "https://thisIsMyDomain.unit.co",
"enabled": true
},
"relationships": {
"emailOutreachSettings": {
"data": {
"type": "emailOutreachSettings",
"id": "10023"
}
},
"messageOutreachSettings": {
"data": {
"type": "messageOutreachSettings",
"id": "10022"
}
},
"whiteLabelTheme": {
"data": {
"type": "whiteLabelTheme",
"id": "54728"
}
}
}
}
}
Update Policy
Verb | PATCH |
Url | https://api.s.unit.sh/fraud-outreach-policies/:policyId |
Data Type | cardFraudOutreachPolicy |
Timeout (Seconds) | 5 |
Attributes
Field | type | Description |
---|---|---|
contactPhone | Phone | Optional. The client support contact phone number. |
contactUrl | string | Optional. The client support contact URL. Should be a valid https URL. |
activitiesLookBackPeriodHours | integer | Optional. The period in hours before the card fraud case was created, for which the card fraud case activities will be included in the case. Can be one of the following periods: 12, 24, 48, 72 . |
caseExpirationPeriodHours | integer | Optional. The period in hours after the card fraud case was created, after which the card fraud case expires. Can be one of the following periods: 12, 24, 48, 72 . |
numberOfActivities | integer | Optional. The number of card activities that will be included in the card fraud case. Up to 5 activities max. |
emailOutreachSettings | string | Optional. The id of the email outreach settings to be used for the policy. |
messageOutreachSettings | string | Optional. The id of the message outreach settings to be used for the policy. |
whiteLabelTheme | string | Optional. The id of the white-label theme to be used for the policy. |
curl -X PATCH 'https://api.s.unit.sh/fraud-outreach-policies/:policyId'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
"data": {
"type": "cardFraudOutreachPolicy",
"attributes": {
"caseExpirationPeriodHours": 72,
"activitiesLookBackPeriodHours": 72,
"contactUrl": "https://thisIsMyDomain.unit.co",
"contactPhone": {
"countryCode": "213",
"number": "5350405030"
},
"numberOfCardActivities": 3,
"emailOutreachSettings": "10001",
"messageOutreachSettings": "10002",
"whiteLabelTheme": "100081"
}
}
}'
Response
Response is a JSON:API document.
200 Ok
Field | Type | Description |
---|---|---|
data | CardFraudOutreachPolicy | The updated CardFraudOutreachPolicy resource. |
{
"data": {
"type": "cardFraudOutreachPolicy",
"id": "1",
"attributes": {
"createdAt": "2024-07-30T14:29:29.986Z",
"activitiesLookBackPeriodHours": 72,
"caseExpirationPeriodHours": 72,
"numberOfActivities": 3,
"contactPhone": {
"countryCode": "213",
"number": "5350405030"
},
"contactUrl": "https://thisIsMyDomain.unit.co",
"enabled": true
},
"relationships": {
"emailOutreachSettings": {
"data": {
"type": "emailOutreachSettings",
"id": "10023"
}
},
"messageOutreachSettings": {
"data": {
"type": "messageOutreachSettings",
"id": "10022"
}
},
"whiteLabelTheme": {
"data": {
"type": "whiteLabelTheme",
"id": "54728"
}
}
}
}
}
Get Policy by Id
Get a card fraud outreach policy by id.
Verb | GET |
Url | https://api.s.unit.sh/fraud-outreach-policies/{id} |
Timeout (Seconds) | 5 |
curl -X GET 'https://api.s.unit.sh/fraud-outreach-policies/1' \
-H "Authorization: Bearer ${TOKEN}"
Response
Response is a JSON:API document.
200 OK
Field | Type | Description |
---|---|---|
data | CardFraudOutreachPolicy | The requested CardFraudOutreachPolicy resource. |