Retrieve a dispute
Retrieve the details of a specific dispute by its ID.
This endpoint is only available in Production environment.
Request
The ID of the Dispute object.
Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"
This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.
It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.
For more information, see: Authentication
Possible values: [2023-09-01, 2024-05-01, 2024-09-01]
Example: "2024-09-01"
The version of the Merchant API, specified in YYYY-MM-DD format.
If not specified, you will receive an error.
For more information about API versioning, see: API versions.
Response
Successful response
Unique identifier of the dispute.
Possible values: [needs_response, under_review, won, lost]
Represents the state of the dispute.
It indicates either the final outcome of the dispute or if further action is required.
| Parameter value | Description |
|---|---|
needs_response | Indicates that the dispute requires a response or action from the merchant. |
under_review | Indicates that the dispute is currently under review, and the outcome is pending. |
won | Indicates that the dispute has been resolved in favor of the merchant. |
lost | Indicates that the dispute has been resolved against the merchant. |
Possible values: [arbitration, lost_accepted, lost_arbitration, lost_expired, lost_pre_arbitration, lost_representment, new, pre_arbitration, representment, won_arbitration, won_pre_arbitration, won_representment, won_reversal]
Provides additional granularity about the dispute state.
It details the progression of the dispute process, showing the current stage or phase.
| Parameter value | Description |
|---|---|
new | The dispute has been recently created and is in the initial phase, awaiting further processing. |
lost_expired | The dispute has been lost due to expiration, likely because the merchant did not respond within the required timeframe. |
pre_arbitration | The dispute is in the pre-arbitration phase, where preliminary evidence is being gathered before a formal arbitration process. |
won_pre_arbitration | The merchant secured a win during the pre-arbitration phase based on the evidence provided. |
lost_pre_arbitration | The dispute was lost during the pre-arbitration phase, indicating that the preliminary review did not favor the merchant. |
lost_accepted | The loss has been accepted as final, implying that no further contestation is likely or needed. |
arbitration | The dispute has escalated to the arbitration stage, where a neutral third party is reviewing the evidence. |
won_arbitration | The merchant won the dispute during the arbitration process. |
lost_arbitration | The merchant lost the dispute during the arbitration process. |
ISO 8601 date and time when the dispute was created.
ISO 8601 date and time when the dispute was last updated.
ISO 8601 date and time until when the merchant needs to respond to the dispute.
The response time by default is 15 days after the dispute is created. If no response is provided by this date, the dispute transitions to:
state: lostsubstate: lost_expired
Dispute reason code from the payment scheme, following standard formats defined by individual providers.
For complete, official lists of dispute codes, see:
- Visa: Visa Core Rules and Visa Product and Service Rules
- Mastercard: Chargeback Guide - Merchant Edition
- American Express: Chargeback Codes
Provides a human-readable explanation for the dispute reason codes.
Disputed amount expressed in minor currency units, according to the ISO 4217 standard. For example, 7034 in EUR corresponds to €70.34.
Conversion between major and minor units varies by currency. For instance, 100 minor units equal £1.00 in GBP, whereas in ISK they represent 100 units. For more details, see the ISO 4217 standard.
Possible length: >= 3 characters and <= 3 characters
ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
Object containing the details of the original payment associated with the dispute.
The ID of the original payment that was disputed.
The ID of the order linked to the original disputed payment.
ISO 8601 date and time when the original disputed payment was created.
Acquirer Reference Number (ARN) of the original payment.
Only returned for payments made by a card.
Amount of the original payment expressed in minor currency units, according to the ISO 4217 standard. For example, 7034 in EUR corresponds to €70.34.
Conversion between major and minor units varies by currency. For instance, 100 minor units equal £1.00 in GBP, whereas in ISK they represent 100 units. For more details, see the ISO 4217 standard.
Possible length: >= 3 characters and <= 3 characters
ISO 4217 currency code in upper case.
For more information about the supported currencies, see: Help Center.
Payment method used for the original payment.
Possible values: [apple_pay, apple_tap_to_pay, card, google_pay, revolut_pay_account, revolut_pay_card]
Type of the payment method used for the original payment.
Available values:
Payment method type | Description |
|---|---|
apple_pay | The customer paid the order using Apple Pay. |
apple_tap_to_pay | The customer paid the order using Apple Tap to Pay. |
card | The customer paid the order using their credit or debit card. |
google_pay | The customer paid the order using Google Pay. |
revolut_pay_card | The customer paid the order via Revolut Pay using their credit or debit card. |
revolut_pay_account | The customer paid the order via Revolut Pay using their Revolut account. |
Possible values: [visa, mastercard, american_express]
The type of the card.
Only returned for payments made by a card.
Possible length: >= 4 characters and <= 4 characters
The last four digits of the card number.
Only returned for payments made by a card.