v1

latestOpenAPI 3.0.02026-08-04620256.0 KB

Fraud Alerts

Get fraud alerts

Retrieve fraud alerts with optional filtering by status and charge ID. Supports pagination.

get/fraud-alert

Query parameters

status'PENDING' | 'CONFIRMED' | 'DECLINED'

Filter by fraud alert status

Example:PENDING

transactionIdstring

Filter by transaction ID

Example:ch_123456

pagenumber float

The page number to retrieve in a paginated response

Example:1

limitnumber float

A limit on the number of objects to be returned

Example:20

fromDatestring date-time

Filter fraud alerts created from this date (inclusive)

Example:2024-01-01

toDatestring date-time

Filter fraud alerts created up to this date (inclusive)

Example:2024-01-31

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Response

Fraud alerts retrieved successfully

Example response

{
  "items": [
    {
      "fraudAlertId": "77d47871-97ce-444d-9987-7569afc51ba7",
      "transactionId": "tid_PA8aw1RiFT",
      "status": "PENDING",
      "cardId": "0587bbc1-b988-4263-ab16-fa806480d865",
      "merchantInfo": {
        "name": "Example Merchant",
        "location": "New York, NY"
      },
      "transactionInfo": {
        "amount": "50.75",
        "currency": "USD",
        "timestamp": "2024-01-24T14:30:00Z"
      }
    }
  ]
}