Get dispute by ID

get/disputes/{id}

API Version

Get a raised dispute by ID.

Endpoint destination URL

Path Parameters

Required

Optional

The unique identifier of the raised dispute.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
arnstring
The unique Acquirer Reference Number (arn) generated by the card scheme for each capture. You can use the arn to trace the transaction through its lifecycle.
descriptionstring
Your description for the dispute.
disputedAmountobject
The amount for which you dispute the transaction. The disputed amount cannot be greater than the transaction amount. If you do not provide an amount, the entire transaction amount will be disputed.
currencystring
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
duplicateInfoobject
Additional information for raising a dispute of type duplicate. Required for disputes of type duplicate.
duplicateTransactionIdstring
The transaction id associated with the duplicate charge for which you are disputing. The disputed transaction must be in the same amount as the duplicate transaction.
sameCardboolean
The duplicate charge was made on the same card. Possible values: true, false.
sameIssuerboolean
The issuer associated with each charge is the same. Possible values: true, false.
fraudInfoobject
Additional information for raising a dispute of type fraud. Required for disputes of type fraud.
cardDoesNotBelongToCardholderboolean
The card is no longer in the cardholder's possession. Set to true if the card is lost or stolen.
cardWasCounterfeitedboolean
The card was counterfeited.
descriptionOfIssuestring
Max length: 2500
Your description of the issue for raising a dispute of type fraud.
reportOnlyboolean
Set to true to report fraud to Adyen with no further action, such as a request for a chargeback or fee reversal. The default value is false.
idstring
The unique identifier of the raised dispute.
notDeliveredInfoobject
Additional information for raising a dispute of type notDelivered. Required for disputes of type notDelivered.
agreedDeliveryLocationstring
Max length: 500
The delivery location specified by the cardholder. Required if deliveredToWrongLocation is true.
dateOfCancellationstring
The date the undelivered goods or services were cancelled in YYYY-MM-DD format.
deliveredToWrongLocationboolean
Indicates goods were delivered to the wrong location.

Possible values: true, false.
descriptionOfIssuestring
Max length: 2500
Your description of the issue for raising a dispute of type notDelivered.
didCardholderReturnboolean
Indicates if the cardholder returned the goods to the merchant. Required if isDeliveryLate is true.

Possible values: true, false.
isDeliveryLateboolean
Indicates if the goods or services were delivered late. Required if whatWasNotDelivered is goods.

Possible values: true, false.
isMerchantBankruptboolean
Indicates if the transaction was processed by a bankrupt merchant.

Possible values: true, false.
isNonFiatOrNftboolean
Indicates if the transaction is non-fiat or non-fungible token (NFT) related.

Possible values: true, false.
lastExpectedDatestring
The date the undelivered goods or services were expected to be delivered in YYYY-MM-DD format.
whatWasNotDeliveredstring
The type of product that you expected to receive.

Possible values: goods, services.
whoCancelledstring
The party that initiated the cancellation of the transaction.

Possible values: merchant, cardholder.
otherInfoobject
Additional information for raising a dispute of type other. Required for disputes of type other

Note: The other dispute type is currently in beta testing. Do not create or submit any disputes for this dispute type at this time.
descriptionOfIssuestring
Max length: 2500
Your description of the issue for raising a dispute of type other.
subTypestring
The specific category of other dispute that you are raising.

Possible values: atmDispute, cancelledGoodsServices, cancelledRecurring, counterfeit, creditNotProcessed, notAsDescribed.
whatWasPurchasedstring
The type of product that you purchased.

Possible values: goods, services.
statusstring
The current status of the dispute.

When you create a dispute, you can only set the status to draft. When you update a dispute, you can set the status to submitted or closed.

Possible values: draft, submitted, closed, won, chargeback, secondPresentment.
transactionIdstring
The unique reference of the transaction for which you are raising the dispute.
typestring
The type of the dispute.

Possible values: duplicate, fraud, notDelivered, other.

Note: The other dispute type is currently in beta testing. Do not create or submit any disputes for this dispute type at this time.
401
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
namestring
The field that has an invalid value.
valuestring
The invalid value.
messagestring
Description of the validation error.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Get dispute by ID

HTTP Responses

200 - OK

401

403

422