Retrieve Dispute Alert

Retrieves a single dispute alert or early fraud warning by ID.

GET /dispute_alerts/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const disputeAlert = await client.disputeAlerts.retrieve('id');

console.log(disputeAlert.id);

200

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "actionable": false,
  "amount": 25,
  "card_brand": "visa",
  "created_at": "2026-01-01T12:00:00.000Z",
  "currency": "usd",
  "fee_charged": false,
  "id": "dspa_xxxxxxxxxxxxxx",
  "issuer": "<string>",
  "not_actionable_reason": "network_resolved",
  "payment_id": "pay_xxxxxxxxxxxxxx",
  "product_id": "prod_xxxxxxxxxxxxxx",
  "reported_at": "2026-01-01T12:00:00.000Z",
  "transaction_at": "2026-01-01T12:00:00.000Z",
  "type": "rapid_dispute_resolution",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Authorizations

Authorization · string · header · required

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

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

The dispute alert ID, prefixed dspa_.

Response

200

application/json

dispute alert returned

account_id · string | null · required

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

Example:

"biz_xxxxxxxxxxxxxx"

actionable · boolean · required

Whether refunding the payment can still avoid a chargeback. false once the payment has been disputed or fully refunded, or when the alert could not be matched to a payment — not_actionable_reason says which.

Example:

false

amount · number · required

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

Example:

25

card_brand · string | null · required

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.

Example:

"visa"

created_at · string · required

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

Example:

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

currency · string · required

Three-letter ISO currency code of the alerted amount.

Example:

"usd"

fee_charged · boolean · required

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.

Example:

false

id · string · required

Dispute alert ID, prefixed dspa_.

Example:

"dspa_xxxxxxxxxxxxxx"

issuer · string | null · required

Name of the bank that issued the card and filed the report.

not_actionable_reason · enum<string> | null · required

Why refunding can no longer avoid a chargeback. network_resolved when a Visa RDR already closed the case, payment_unmatched when no payment matched, payment_not_captured when it never captured money, payment_disputed once the payment carries a dispute, payment_refunded once fully refunded. null while actionable is true.

Available options: network_resolved, payment_unmatched, payment_not_captured, payment_disputed, payment_refunded, null

Example:

"network_resolved"

payment_id · string | null · required

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

Example:

"pay_xxxxxxxxxxxxxx"

product_id · string | null · required

The product the alerted payment was for, prefixed prod_.

Example:

"prod_xxxxxxxxxxxxxx"

reported_at · string · required

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

Example:

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

transaction_at · string | null · required

When the reported transaction was made, as an ISO 8601 timestamp.

Example:

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

type · enum<string> · required

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.

Available options: early_fraud_warning, dispute_alert, rapid_dispute_resolution

Example:

"rapid_dispute_resolution"

updated_at · string · required

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

Example:

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