Search

Are you looking for test card numbers?

Would you like to contact support?

Risk-management icon

Disputes API reference

To communicate with the Adyen API you should submit HTTP POST requests to corresponding endpoints. These endpoints differ for test and live accounts, and also depend on the data format (SOAP, JSON, or FORM) you use to submit data to the Adyen payments platform.

This document lists all endpoints available for you to integrate with the test platform and run QA checks.

Indicators used in this section:

-white_check_mark- This field is mandatory and must be always present.
-x- This field is optional and may be required in specific scenarios.

Endpoints

SOAP

Test

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

Live

https://ca-live.adyen.com/ca/services/DisputeService

The data schema for the corresponding SOAP objects is available at:

Test

https://ca-test.adyen.com/ca/services/DisputeService?wsdl

Live

https://ca-live.adyen.com/ca/services/DisputeService?wsdl

JSON and FORM

JSON and FORM communication formats are currently not available for the Disputes API.

DefendDisputeRequest

Field Type Required Description
defenseReasonCode String -white_check_mark- The defense reason selected to defend against the dispute.
disputePspReference String -white_check_mark- The reference assigned to the dispute.
merchantAccount String -white_check_mark- The merchant account identifier you want to process the (transaction) request with.

DefendDisputeResponse

Field Type Required Description
disputeServiceResult DisputeServiceResult -white_check_mark- A container for the response result.

DefenseDocument

 

Field Type Required Description
content Base64 binary -white_check_mark-

The content of the document in Base64 Binary format.

It must be in the format specified in the field contentType.

contentType String -white_check_mark-

The content type of the document.

Possible values are:

  • image/jpg
  • image/jpeg
  • image/tiff
  • application/pdf
  • text/clearing
defenseDocumentTypeCode String -white_check_mark-

One of the defense document type codes you obtained in the Retrieve Applicable Defense Reasons response.

In addition to predefined document types you can also provide a generalized defense document type. If you need to configure this functionality for your account, contact the Support Team.

When this feature is enabled, you can supply a generic defense document to the schemes for the defense reason. When supplying such documents, set the defenseDocumentTypeCode property to AlternativeDefenseMaterial.

DefenseDocumentType

A container for a defense document type.

Field Type Required Description
available Boolean -white_check_mark- This is a flag to mark if the document is already present in the dispute service, or still requires your submission.
defenseDocumentTypeCode String -white_check_mark-

A code identifying the type of defense document requested.

If required, a full list of defense defense document types can be requested from the Support Team.

requirementLevel

String -white_check_mark-

Level of requirement of the documents for a successful defense.

There are three possible values:

  • Required. The document must be supplied.
  • OneOrMore. At least one of the documents with this label must be supplied.
  • Optional. This document is optional to supply.

DefenseReason

A container for a defense reason.

Field Type Required Description
defenseDocumentTypes Array of DefenseDocumentType  -white_check_mark- A specified list of defense document types that can be submitted to the schemes for the defense reason.
defenseReasonCode String -white_check_mark-

A code identifying the defense reason.

If required, a full list of defense reasons codes can be requested to the Adyen Support (support@adyen.com).

satisfied Boolean -white_check_mark-

A flag indicating if sufficient defense material has been supplied to defend against the dispute with the given defense reason.

DefenseReasonsRequest

Field Type Required Description
disputePspReference String -white_check_mark- The reference assigned to the dispute.
merchantAccount String -white_check_mark- The merchant account identifier you want to process the (transaction) request with.

DefenseReasonsResponse

Field Type Required Description
defenseReasons Array of DefenseReason -white_check_mark-

A list of defense reasons that are applicable to the dispute.

 

disputeServiceResult

DisputeServiceResult -white_check_mark-

A container for result of this response.

DeleteDefenseDocumentRequest

Field Type Required Description
disputePspReference String -white_check_mark- The reference we have assigned to the dispute.
merchantAccount String -white_check_mark- The merchant account identifier you want to process the (transaction) request with.
defenseDocumentType String -white_check_mark- The defense document type code supplied in the Retrieve Applicable Defense Reasons request.

DeleteDefenseDocumentResponse

Field Type Required Description

disputeServiceResult

DisputeServiceResult -white_check_mark-

A container for result of this response.

 

DisputeServiceResult

A container for result of the response.

Field Type Required Description
success Boolean -white_check_mark- Success of the operation. If unsuccessful an error message will be given in the next field.
errorMessage String -x- A textual description of the error.

SupplyDefenseDocumentRequest

  Field Type Required Description
defenseDocuments Array of DefenseDocument  -white_check_mark- A container of list of defense documents.
disputePspReference String -white_check_mark- The reference we have assigned to the dispute.
merchantAccount String -white_check_mark- The merchant account identifier you want to process the (transaction) request with.

SupplyDefenseDocumentResponse

Field Type Required Description
disputeServiceResult DisputeServiceResult -white_check_mark- A container for result of this response.