Card Fraud Outreach APIs

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

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

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).

Example response:
{
  "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
    }
  }
}

Mark Card Fraud Case as Fraud

Important Info

If you are using our White Label Card Fraud Outreach solution, we encourage you not to use this API. The status of the Card Fraud Case will be updated automatically according to its lifecycle stage.

This action is irreversible. Once a card fraud case is marked as Fraud, it cannot be changed back to No Fraud. Calling this action repeatedly for the same card fraud case id will result in an error.

Mark a card fraud case as Fraud.

Verb	`POST`
URL	`https://api.s.unit.sh/card-fraud-cases/{id}/fraud`
Data Type	`markAsFraudRequest`
Timeout (Seconds)	`5`

Attributes

fraudulentActivityIds

Array of integers

The ids of the fraudulent activities. The activities are the card activities that are marked as fraudulent. The activities are linked to the card fraud case.

Example Request:

curl -X POST 'https://api.s.unit.sh/card-fraud-cases/1/fraud'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "markAsFraudRequest",
    "attributes": {
      "fraudulentActivityIds": [
        "15",
        "16",
        "17"
      ]
    }
  }
}'

Response

Response is a JSON:API document.

200 OK

data

Authorization Card Fraud Case or Transaction Card Fraud Case

The Card Fraud Case resource updated as Fraud. Can be either Authorization or Transaction as indicated by the type field.

Mark Card Fraud Case as No Fraud

Important Info

If you are using our White Label Card Fraud Outreach solution, we encourage you not to use this API. The status of the Card Fraud Case will be updated automatically according to its lifecycle stage.

This action is irreversible. Once a card fraud case is marked as No Fraud, it cannot be changed back to Fraud. Calling this action repeatedly for the same card fraud case id will result in an error.

Mark a card fraud case as No Fraud.

Verb	`POST`
URL	`https://api.s.unit.sh/card-fraud-cases/{id}/no-fraud`
Timeout (Seconds)	`5`

curl -X POST 'https://api.s.unit.sh/card-fraud-cases/1/no-fraud'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'

Response

Response is a JSON:API document.

200 OK

data

Authorization Card Fraud Case or Transaction Card Fraud Case

The Card Fraud Case resource updated as No Fraud. Can be either Authorization or Transaction as indicated by the type field.

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.
fraudRulesSuppressionDays	integer	1	Optional. Sets suppression window (1–7 days) for fraud rules following a confirmed legitimate transaction. Up to 7 days maximum.
idempotencyKey	string	(empty)	Optional. See Idempotency.

Relationships

whiteLabelThemeOptional

JSON:API Relationship

Optional. The white-label theme to be used for the policy. See White-Label Theme.

emailOutreachSettingsOptional

JSON:API Relationship

Optional. The email outreach settings to be used for the policy.

messageOutreachSettingsOptional

JSON:API Relationship

Optional. The message outreach settings to be used for the policy.

Example Request:

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,
      "fraudRulesSuppressionDays": 1
    },
    "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

data

CardFraudOutreachPolicy

The created CardFraudOutreachPolicy resource.

Example response:
{
  "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",
      "fraudRulesSuppressionDays": 1,
      "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

contactPhoneOptional

Phone

Optional. The client support contact phone number.

contactUrlOptional

string

Optional. The client support contact URL. Should be a valid https URL.

activitiesLookBackPeriodHoursOptional

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.

caseExpirationPeriodHoursOptional

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.

numberOfActivitiesOptional

integer

Optional. The number of card activities that will be included in the card fraud case. Up to 5 activities max.

fraudRulesSuppressionDaysOptional

integer

Optional. Sets suppression window (1–7 days) for fraud rules following a confirmed legitimate transaction. Up to 7 days maximum.

emailOutreachSettingsOptional

string

Optional. The id of the email outreach settings to be used for the policy.

messageOutreachSettingsOptional

string

Optional. The id of the message outreach settings to be used for the policy.

whiteLabelThemeOptional

string

Optional. The id of the white-label theme to be used for the policy.

Example Request:

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,
      "fraudRulesSuppressionDays": 1,
      "emailOutreachSettings": "10001",
      "messageOutreachSettings": "10002",
      "whiteLabelTheme": "100081"
    }
  }
}'

Response

Response is a JSON:API document.

200 Ok

data

CardFraudOutreachPolicy

The updated CardFraudOutreachPolicy resource.

Example response:
{
  "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",
      "fraudRulesSuppressionDays": 1,
      "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

data

CardFraudOutreachPolicy

The requested CardFraudOutreachPolicy resource.

Get Card Fraud Case by Id​

Response​

200 OK​

List Card Fraud Cases​

Query Parameters​

Response​

200 OK​

Mark Card Fraud Case as Fraud​

Attributes​

Response​

200 OK​

Mark Card Fraud Case as No Fraud​

Response​

200 OK​

Create Policy​

Attributes​

Relationships​

Response​

201 Created​

Update Policy​

Attributes​

Response​

200 Ok​

Get Policy by Id​

Response​

200 OK​

Get Card Fraud Case by Id

Response

200 OK

List Card Fraud Cases

Query Parameters

Response

200 OK

Mark Card Fraud Case as Fraud

Attributes

Response

200 OK

Mark Card Fraud Case as No Fraud

Response

200 OK

Create Policy

Attributes

Relationships

Response

201 Created

Update Policy

Attributes

Response

200 Ok

Get Policy by Id

Response

200 OK