Skip to main content
PATCH
TypeScript

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

The dispute ID (dspt_ tag).

Cuerpo

evidence
object

The evidence packet to send to the processor. Only the fields you provide are changed.

Respuesta

dispute updated

acceptable
boolean
requerido

Whether the dispute can be conceded to the customer with POST /disputes/{id}/accept. True only for a chargeback still awaiting a response, before evidence_due_at, whose payment processor supports accepting disputes. Inquiries are never acceptable.

Ejemplo:

true

account_id
string | null
requerido

The account the dispute was filed against, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

amount
number
requerido

The disputed amount, in whole units of currency.

Ejemplo:

150

buyer
object
requerido

The customer who filed the dispute.

created_at
string
requerido

When the dispute was opened, as an ISO 8601 timestamp.

Ejemplo:

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

currency
string
requerido

Three-letter ISO currency code of the disputed amount.

Ejemplo:

"usd"

evidence
object
requerido

The evidence packet sent to the processor to contest the dispute.

evidence_due_at
string | null
requerido

The deadline to submit evidence, as an ISO 8601 timestamp. null when the network already auto-resolved the dispute (Visa RDR) with no evidence round, or when the processor hasn't reported a deadline for this dispute.

Ejemplo:

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

evidence_editable
boolean
requerido

Whether evidence can still be changed and submitted.

Ejemplo:

true

evidence_locked_reason
enum<string> | null
requerido

Why evidence can no longer be edited. null while evidence_editable is true.

Opciones disponibles:
submitted,
response_window_closed,
not_contestable,
null
Ejemplo:

"submitted"

evidence_submitted_at
string | null
requerido

When the evidence was submitted to the processor, as an ISO 8601 timestamp.

Ejemplo:

null

fee
object | null
requerido

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

fee_charged
boolean
requerido

Whether Whop charged the account a dispute fee for this one. false when the payment was fully refunded before the dispute was opened, for a Visa RDR resolution, and for an inquiry.

Ejemplo:

true

id
string
requerido

Dispute ID, prefixed dspt_.

Ejemplo:

"dspt_xxxxxxxxxxxxxx"

inquiry
boolean
requerido

Whether this is a pre-dispute inquiry rather than a formal chargeback. Inquiries follow the same lifecycle but move no funds unless one escalates.

Ejemplo:

false

issuer_comments
object[]
requerido
line_items
object[]
requerido
payment
object
requerido

The payment being disputed.

product_id
string | null
requerido

The product the disputed payment was for, prefixed prod_.

Ejemplo:

"prod_xxxxxxxxxxxxxx"

reason
enum<string>
requerido

Why the customer says they are disputing, normalized across processors and card networks. other covers a processor reason Whop has not categorized yet.

Opciones disponibles:
fraudulent,
unrecognized,
declined_authorization,
product_not_received,
product_unacceptable,
subscription_canceled,
credit_not_processed,
duplicate,
processing_error,
documentation_request,
bank_cannot_process,
other
Ejemplo:

"other"

reason_code
string | null
requerido

The raw card-network or processor reason code, such as 10.4. Informational only — reason is not derived from it.

Ejemplo:

"13.1"

status
enum<string>
requerido

needs_response awaits evidence (after a processor refused a filing, submission_failure_reason says why); generating_response has evidence with the processor, not yet accepted; under_review is with the processor; won/lost are the rulings; prevented settles like lost. warning_ statuses are the inquiry tiers. Past evidence_due_at an open one reports under_review.

Opciones disponibles:
needs_response,
warning_needs_response,
under_review,
warning_under_review,
generating_response,
won,
lost,
prevented,
warning_closed
Ejemplo:

"needs_response"

submission_failure_reason
string | null
requerido

Why the payment processor refused the last filing, in plain English, while the dispute is back in needs_response. Fix what it names and submit again. Only on retrieve: dispute.updated reports the move back to needs_response, then read this here.

Ejemplo:

null

updated_at
string
requerido

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

Ejemplo:

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

variant_id
string | null
requerido

The variant the disputed payment was made on, prefixed plan_.

Ejemplo:

"plan_xxxxxxxxxxxxxx"