Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Dispute alerts

Retrieve dispute alert

Retrieves the details of an existing dispute alert.

Required permissions:

  • payment:dispute_alert:read
  • payment:basic:read
  • member:email:read
  • member:basic:read
  • member:phone:read
  • payment:dispute:read
get/dispute_alerts/{id}

Path parameters

idstring required
Example:dspa_xxxxxxxxxxxxx

The unique identifier of the dispute alert.

Response

A successful response

alert_type'dispute' | 'dispute_rdr' | 'fraud' required

The type of dispute alert.

amountnumber required

The alerted amount in the specified currency.

charge_for_alertboolean required

Whether this alert incurs a charge.

created_atstring date-time required

The time the dispute alert was created.

currency'usd' | 'sgd' | 'inr' | 'aud' | 'brl' | 'cad' | 'dkk' | 'eur' | 'nok' | 'gbp' | 'sek' | 'chf' | 'hkd' | 'huf' | 'jpy' | 'mxn' | 'myr' | 'pln' | 'czk' | 'nzd' | 'aed' | 'eth' | 'ape' | 'cop' | 'ron' | 'thb' | 'bgn' | 'idr' | 'dop' | 'php' | 'try' | 'krw' | 'twd' | 'vnd' | 'pkr' | 'clp' | 'uyu' | 'ars' | 'zar' | 'dzd' | 'tnd' | 'mad' | 'kes' | 'kwd' | 'jod' | 'all' | 'xcd' | 'amd' | 'bsd' | 'bhd' | 'bob' | 'bam' | 'khr' | 'crc' | 'xof' | 'egp' | 'etb' | 'gmd' | 'ghs' | 'gtq' | 'gyd' | 'ils' | 'jmd' | 'mop' | 'mga' | 'mur' | 'mdl' | 'mnt' | 'nad' | 'ngn' | 'mkd' | 'omr' | 'pyg' | 'pen' | 'qar' | 'rwf' | 'sar' | 'rsd' | 'lkr' | 'tzs' | 'ttd' | 'uzs' | 'rub' | 'btc' | 'cny' | 'usdt' | 'kzt' | 'awg' | 'whop_usd' | 'xau' required

The available currencies on the platform

idstring required

The unique identifier of the dispute alert.

transaction_datestring date-time nullable required

The date of the original transaction.

Example response

{
  "amount": 6.9,
  "created_at": "2023-12-01T05:00:00.401Z",
  "dispute": {
    "amount": 6.9,
    "created_at": "2023-12-01T05:00:00.401Z",
    "id": "dspt_xxxxxxxxxxxxx",
    "reason": "Product Not Received"
  },
  "id": "dspa_xxxxxxxxxxxxx",
  "payment": {
    "card_last4": "4242",
    "created_at": "2023-12-01T05:00:00.401Z",
    "dispute_alerted_at": "2023-12-01T05:00:00.401Z",
    "id": "pay_xxxxxxxxxxxxxx",
    "membership": {
      "id": "mem_xxxxxxxxxxxxxx"
    },
    "paid_at": "2023-12-01T05:00:00.401Z",
    "subtotal": 6.9,
    "total": 6.9,
    "usd_total": 6.9,
    "user": {
      "email": "john.doe@example.com",
      "id": "user_xxxxxxxxxxxxx",
      "name": "John Doe",
      "username": "johndoe42"
    }
  },
  "transaction_date": "2023-12-01T05:00:00.401Z"
}