Sign in

v1

latestOpenAPI 3.0.02026-07-262561105.1 KB
Disputes API

Get dispute

get/disputes/{dispute_id}

Path parameters

dispute_idstring required

Unique identifier of the dispute

Response

Success

tokenstring
idstring

ID of dispute

transaction_idstring

ID of associated charge with the dispute

order_idstring

Merchant reference for associated order with the dispute

openboolean

Indicates if dispute is open or not.

transaction_amountinteger

Total amount in cents of transaction which is being disputed

dispute_amountinteger

Dispute amount in the smallest denomination of the currency, such as cents

currencystring

The local currency of the dispute, must be a valid subset of the ISO 4217 currency code

dispute_reason'cancellation_or_return_not_processed' | 'incorrect_amount' | 'product_not_received' | 'product_unacceptable' | 'cancellation_not_processed' | 'return_not_processed'

Dispute reason

status'action_required_merchant' | 'no_merchant_action_needed' | 'closed_customer_favor' | 'closed_merchant_favor' | 'closed_customer_partial_favor'

Current dispute status

response_due_bystring date-time

Deadline by which merchant must respond to the dispute, in ISO 8601 UTC format

createdstring date-time

Timestamp indicating when the dispute was opened, in ISO 8601 UTC format

updatedstring date-time

Timestamp indicating when the dispute was last updated, in ISO 8601 UTC format

commentsstring[]

Text blob from the customer describing the complaint reason for the dispute

closed_atstring date-time

Timestamp indicating when the dispute was closed, in ISO 8601 UTC format

evidence_received_atstring date-time

Timestamp indicating when evidence was received for this dispute, in ISO 8601 UTC format