Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Risk Evaluations

List risk evaluation overrides

List evaluation overrides.

get/evaluation_overrides

Query parameters

account_idstring[]

Unique identifier for the customer account. Multiple IDs can be provided as a comma-separated list.

idstring[]

Unique identifier for the evaluation override. Multiple IDs can be provided as a comma-separated list.

spend_control_idstring[]

Unique identifier for the spend control. Multiple IDs can be provided as a comma-separated list.

card_idstring[]

Unique identifier for the card. Multiple IDs can be provided as a comma-separated list.

type'FRAUD' | 'SPEND_CONTROL'

The type of evaluation override. Always present in responses; behavior and filtering depend on this field.

Filter by the type of evaluation override.

reasonstring
Example:manual_review

Filter by the reason for the evaluation override.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
sort_bystring[]

Specifies the sort order for the returned evaluation override list.

transaction_idstring[]

Unique identifier for the transaction. Multiple IDs can be provided as a comma-separated list.

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
customer_idstring[]

Unique identifier for the customer. Multiple IDs can be provided as a comma-separated list.

Response

List of evaluation overrides.

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "evaluation_overrides": [
    {
      "account_id": "30044785-ddb0-4a51-be1c-402bd4ba2b2b",
      "active_at": "2024-01-01T00:00:00.000Z",
      "card_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "creation_time": "2010-05-06T12:23:34.321Z",
      "customer_id": "5f4ff599-7c29-4f69-a3d9-e103e151afbd",
      "expires_at": "2024-12-31T23:59:59.000Z",
      "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "reason": "False positive - customer confirmed transaction is legitimate.",
      "spend_control_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "transaction_id": "f387d971-d23b-4cc0-997a-7bc4f895fe9a"
    }
  ],
  "next_page_token": "a8937a0d"
}