Get applicable defense reasons

post/retrieveApplicableDefenseReasons

Returns a list of all applicable defense reasons to defend a specific dispute.

Endpoint destination URL

https://ca-test.adyen.com/ca/services/DisputeService/v30/retrieveApplicableDefenseReasons

Request Parameters

Required

Optional

The PSP reference assigned to the dispute.

The merchant account identifier, for which you want to process the dispute transaction.

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.
Show moreShow less
defenseReasonsarray[object]
The defense reasons that can be used to defend the dispute.
Show children Hide children
defenseDocumentTypesarray[object]
Array of defense document types for a specific defense reason. Indicates the document types that you can submit to the schemes to defend this dispute, and whether they are required.
Show children Hide children
availableboolean
When true, you've successfully uploaded this type of defense document. When false, you haven't uploaded this defense document type.
defenseDocumentTypeCodestring
The document type code of the defense document.
requirementLevelstring
Indicates to what extent the defense document is required in the defense process.

Possible values:

Required: You must supply the document.

OneOrMore: You must supply at least one of the documents with this label.

Optional: You can choose to supply the document.

AlternativeRequired: You must supply a generic defense document. To enable this functionality, contact our Support Team. When enabled, you can supply a generic defense document for all schemes.

defenseReasonCodestring
The defense reason code that was selected to defend this dispute.
satisfiedboolean
Indicates if sufficient defense material has been supplied.
disputeServiceResultobject
The result of the dispute service.
Show children Hide children
errorMessagestring
The general error message.
successboolean
Indicates whether the request succeeded.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Get applicable defense reasons

Request Parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error