Disputes
Create a dispute
Opens a dispute for a settled transaction.
POST
Create a dispute
Authorizations
Secret API key, e.g. sk_live_... or sk_test_....
Headers
Unique key that makes the request safe to retry. Keys expire after 24 hours.
Maximum string length:
255Body
application/json
Example:
"txn_01JZ8P7H2R"
Available options:
fraud, duplicate, incorrect_amount, goods_not_received, goods_not_as_described, other Defaults to the full transaction amount.
Required range:
x >= 1Free-form supporting details, e.g. a description or file IDs.
Response
Created.
Unique identifier, prefixed with dsp_.
Example:
"dsp_01JZ9C2K4M"
Object type.
Available options:
dispute Example:
"txn_01JZ8P7H2R"
Disputed amount. In the smallest currency unit (e.g. cents).
Required range:
x >= 0Example:
1299
Three-letter ISO 4217 currency code.
Pattern:
^[A-Z]{3}$Example:
"EUR"
Available options:
fraud, duplicate, incorrect_amount, goods_not_received, goods_not_as_described, other Available options:
open, under_review, won, lost, withdrawn Time the dispute was opened.
Time the dispute was resolved.