Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payment:dispute_alert:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The dispute alert ID, prefixed dspa_.

Respons

dispute alert returned

account_id
string | null
vereist

The account the alerted payment belongs to, prefixed biz_. null while the alert is unmatched.

Voorbeeld:

"biz_xxxxxxxxxxxxxx"

amount
number
vereist

The alerted amount, in whole units of currency. This is what the issuer reported, which can differ from the payment's own amount.

Voorbeeld:

25

auto_refunded
boolean
vereist

Whether Whop automatically refunded the alerted payment. Reflects the payment, so it can be true for a refund issued by another flow (RDR, resolution) on the same payment.

Voorbeeld:

false

card_brand
string | null
vereist

The card network as reported by the issuer, lowercased, such as visa or mastercard. unknown when the report carries neither a network nor a recognizable BIN.

Voorbeeld:

"visa"

category
enum<string> | null
vereist

What the cardholder claims. fraud when they say they didn't make the payment: always for an early_fraud_warning, and for Ethoca fraud alerts and Visa RDR cases filed under a fraud reason. customer_dispute when they made the payment but dispute it, such as a product not received or a canceled subscription. null when the alert carries no claim, such as an issuer's request for transaction documents.

Beschikbare opties:
fraud,
customer_dispute,
null
Voorbeeld:

"fraud"

created_at
string
vereist

When Whop received the alert, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

currency
string
vereist

Three-letter ISO currency code of the alerted amount.

Voorbeeld:

"usd"

fee
object | null
vereist

The alert fee charged to the account, in the currency it was collected in. null when fee_charged is false.

fee_charged
boolean
vereist

Whether Whop charged the account an alert fee for this one. Always false for early_fraud_warning, which Whop is not billed for and never passes on.

Voorbeeld:

false

id
string
vereist

Dispute alert ID, prefixed dspa_.

Voorbeeld:

"dspa_xxxxxxxxxxxxxx"

issuer
string | null
vereist
verouderd

Deprecated: always null outside Whop's own dashboard. Name of the bank that issued the card and filed the report. DEPRECATED: Always null outside Whop's own dashboard.

Voorbeeld:

null

payment_id
string | null
vereist

The payment the issuer reported, prefixed pay_. null when Whop could not match the report to a payment.

Voorbeeld:

"pay_xxxxxxxxxxxxxx"

product_id
string | null
vereist

The product the alerted payment was for, prefixed prod_.

Voorbeeld:

"prod_xxxxxxxxxxxxxx"

reported_at
string
vereist

When the issuer filed the report, as an ISO 8601 timestamp. Earlier than created_at, which is when Whop received it.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

source
enum<string> | null
vereist

The network program that sent the alert, which type alone doesn't tell apart. ethoca for Mastercard Ethoca, cdrn for Visa Verifi CDRN, rdr for Visa RDR, tc40 / safe for a Visa / Mastercard fraud report, paypal for a PayPal alert. null when the network didn't say.

Beschikbare opties:
ethoca,
cdrn,
rdr,
tc40,
safe,
paypal,
null
Voorbeeld:

"tc40"

transaction_at
string | null
vereist

When the reported transaction was made, as an ISO 8601 timestamp — falls back to when the matched payment was made if the issuer's own report didn't carry one. Should not be null in practice; treat one as a data issue rather than expected behavior.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

type
enum<string>
vereist

What the issuer sent. early_fraud_warning is a fraud report on a settled payment (Visa TC40 / Mastercard SAFE) — refunding still avoids the chargeback, and Whop never charges a fee for one. dispute_alert is a pre-dispute notice from the issuer's alert network, which Whop pays for and passes on as a fee. rapid_dispute_resolution is a Visa RDR case the network already closed by refunding the payment — nothing is left to act on.

Beschikbare opties:
early_fraud_warning,
dispute_alert,
rapid_dispute_resolution
Voorbeeld:

"early_fraud_warning"

updated_at
string
vereist

When the alert was last changed, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"