Adyen

Disputes API

You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to…

Payments#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

You can use the Disputes API to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes.

Authentication

Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in How to get the API key. Then set this key to the X-API-Key header value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: Your_API_key" \
...

Note that when going live, you need to generate new web service user credentials to access the live endpoints.

Versioning

Disputes API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

For example:

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

Endpoints 5

General

  • POSTAccept a dispute/acceptDisputeAccepts a specific dispute.
  • POSTDefend a dispute/defendDisputeDefends a specific dispute.
  • POSTDelete a defense document/deleteDisputeDefenseDocumentDeletes a specific dispute defense document that was supplied earlier.
  • POSTGet applicable defense reasons/retrieveApplicableDefenseReasonsReturns a list of all applicable defense reasons to defend a specific dispute.
  • POSTSupply a defense document/supplyDefenseDocumentSupplies a specific dispute defense document.

API details

Base URL
https://ca-test.adyen.com/ca/services/DisputeService/v30
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
5 operations on 5 pathsPOST 5
Main resources
General 5
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 30

How to test the Disputes API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Disputes API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept a dispute” (POST /acceptDispute), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Disputes API?

You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to… It is listed under Payments and has 5 endpoints.

Who publishes the Disputes API?

It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Disputes API?

Requests go to https://ca-test.adyen.com/ca/services/DisputeService/v30. Endpoint paths are added to this base URL.

How do I authenticate with the Disputes API?

It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the Disputes API have?

5 operations on 5 paths (5 POST). The largest groups are General.

Is forking the Disputes API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.