Skip to main content
GET
Retrieve dispute alert
This page documents the Legacy API. For new integrations, use Retrieve Dispute Alert in the Current API.
Required permissions:
  • payment:dispute_alert:read
  • payment:basic:read
  • member:email:read
  • member:basic:read
  • member:phone:read
  • payment:dispute:read

Autorisaties

Authorization
string
header
vereist

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

payment:dispute_alert:read
payment:basic:read
member:email:read
member:basic:read
member:phone:read
payment:dispute:read

Padparameters

id
string
vereist

The unique identifier of the dispute alert.

Voorbeeld:

"dspa_xxxxxxxxxxxxx"

Respons

A successful response

A dispute alert represents an early warning notification from a payment processor about a potential dispute or chargeback.

alert_type
enum<string>
vereist

The type of the dispute alert.

Beschikbare opties:
dispute,
dispute_rdr,
fraud
amount
number
vereist

The alerted amount in the specified currency.

Voorbeeld:

6.9

charge_for_alert
boolean
vereist

Whether this alert incurs a charge.

created_at
string<date-time>
vereist

The time the dispute alert was created.

Voorbeeld:

"2023-12-01T05:00:00.401Z"

currency
enum<string>
vereist

The three-letter ISO currency code for the alerted amount.

Beschikbare opties:
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,
hnl
dispute
object | null
vereist

The dispute associated with the dispute alert.

id
string
vereist

The unique identifier of the dispute alert.

Voorbeeld:

"dspa_xxxxxxxxxxxxx"

payment
object | null
vereist

The payment associated with the dispute alert.

transaction_date
string<date-time> | null
vereist

The date of the original transaction.

Voorbeeld:

"2023-12-01T05:00:00.401Z"