Raise disputes API
Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card, or to report instances of fraud. You can also add…
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
Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card, or to report instances of fraud. You can also add attachments as supporting information for a raised dispute, update information about the dispute, submit the dispute for a chargeback, or close the dispute.
Authentication
Your Adyen contact will provide your API credential and an API key. To connect to the API, add an X-API-Key header with the API key as the value, for example:
curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...Alternatively, you can use the username and password to connect to the API using basic authentication. For example:
curl
-H "Content-Type: application/json" \
-U "ws@BalancePlatform.YOUR_BALANCE_PLATFORM":"YOUR_WS_PASSWORD" \
...Roles and permissions
To use the Disputes API, you need an additional role for your API credential. Your Adyen contact will set up the roles and permissions for you.
Versioning
The 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://balanceplatform-api-test.adyen.com/btl/api/v{version}/disputesGoing live
When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to https://balanceplatform-api-live.adyen.com/btl/api/v{version}.
Endpoints 8
Dispute Attachments
- GETGet all attachments linked to a raised dispute
/disputes/:disputeId/attachmentsGet a list of attachments associated with a dispute ID. - POSTAdd an attachment to a dispute
/disputes/:disputeId/attachmentsAdd supporting information as an attachment for the raised dispute. Upload receipts, communication, or any other documentation to support the dispute. - GETGet an attachment
/disputes/:disputeId/attachments/:attachmentIdSearch for a single attachment, providing the specific dispute ID and attachment ID. - DELETEDelete attachment from a dispute
/disputes/:disputeId/attachments/:attachmentIdRemoves the attachment from the raised dispute. Adyen may keep this file for compliance purposes.
Raise Disputes
- GETGet a list of raised disputes
/disputes?status=string&paymentInstrument=string&createdSince=string&createdUntil=string&offset=string&limit=stringReturns a list of raised disputes that match the query parameters. This endpoint supports cursor-based pagination. The response returns the first page of… - POSTRaise a dispute
/disputesRaise a dispute for an underlying transaction, providing a dispute type and the amount you want to dispute. Raising a dispute returns a dispute ID, which you… - GETGet dispute by ID
/disputes/:idGet a raised dispute by ID. - PATCHUpdate a raised dispute
/disputes/:idUpdate information related to a raised dispute, or change a dispute's status from draft to submitted or closed. Note: Changing the status of a dispute to…
API details
- Base URL
https://balanceplatform-api-test.adyen.com/btl/api/v4https://balanceplatform-api-live.adyen.com/btl/api/v4- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 8 operations on 4 pathsGET 4POST 2PATCH 1DELETE 1
- Main resources
- Dispute Attachments 4Raise Disputes 4
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
4 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Raise disputes API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Raise disputes API collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Get all attachments linked to a raised dispute” (GET /disputes/:disputeId/attachments), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Raise disputes API?
Disputes API for Issuing that you can use to raise disputes on transactions made with an Adyen-issued card, or to report instances of fraud. You can also add… It is listed under Payments and has 8 endpoints.
Who publishes the Raise 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 Raise disputes API?
Its description lists 2 base URLs: https://balanceplatform-api-test.adyen.com/btl/api/v4, https://balanceplatform-api-live.adyen.com/btl/api/v4. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Raise 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 Raise disputes API have?
8 operations on 4 paths (4 GET, 2 POST, 1 PATCH, 1 DELETE). The largest groups are Dispute Attachments, Raise Disputes.
Is forking the Raise disputes API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.