Account API
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration…
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
This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead.
The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.
For more information, refer to our documentation.
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
-U "ws@MarketPlace.YOUR_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \
-H "Content-Type: application/json" \
...When going live, you need to generate new web service user credentials to access the live endpoints.
Versioning
The Account 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://cal-test.adyen.com/cal/services/Account/v6/createAccountHolderEndpoints 20
Account holders
- POSTClose an account holder
/closeAccountHolderChanges the status of an account holder to Closed. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or… - POSTClose stores
/closeStoresCloses stores associated with an account holder. - POSTCreate an account holder
/createAccountHolderCreates an account holder that represents the sub-merchant's entity in your platform. The details that you need to provide in the request depend on the… - POSTGet an account holder
/getAccountHolderReturns the details of an account holder. - POSTGet a tax form
/getTaxFormGenerates a tax form for account holders operating in the US. For more information, refer to Providing tax forms. - POSTSuspend an account holder
/suspendAccountHolderChanges the status of an account holder to Suspended. - POSTUnsuspend an account holder
/unSuspendAccountHolderChanges the status of an account holder from Suspended to Inactive. Account holders can have a Suspended status if you suspend them through the… - POSTUpdate an account holder
/updateAccountHolderUpdates the accountHolderDetails and processingTier of an account holder, and adds bank accounts and shareholders. When updating accountHolderDetails,… - POSTUpdate payout or processing state
/updateAccountHolderStateDisables or enables the processing or payout state of an account holder.
Accounts
- POSTClose an account
/closeAccountCloses an account. If an account is closed, you cannot process transactions, pay out its funds, or reopen it. If payments are made to a closed account, the… - POSTCreate an account
/createAccountCreates an account under an account holder. An account holder can have multiple accounts. - POSTUpdate an account
/updateAccountUpdates the description or payout schedule of an account.
Verification
- POSTTrigger verification
/checkAccountHolderTriggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing. - POSTDelete bank accounts
/deleteBankAccountsDeletes bank accounts associated with an account holder. - POSTDelete legal arrangements
/deleteLegalArrangementsDeletes legal arrangements and/or legal arrangement entities associated with an account holder. - POSTDelete payout methods
/deletePayoutMethodsDeletes payout methods associated with an account holder. - POSTDelete shareholders
/deleteShareholdersDeletes shareholders associated with an account holder. - POSTDelete signatories
/deleteSignatoriesDeletes signatories associated with an account holder. - POSTGet documents
/getUploadedDocumentsReturns documents that were previously uploaded for an account holder. Adyen uses the documents during the verification process. - POSTUpload a document
/uploadDocumentUploads a document for an account holder. Adyen uses the documents during the verification process.
API details
- Base URL
https://cal-test.adyen.com/cal/services/Account/v6- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 20 operations on 20 pathsPOST 20
- Main resources
- Account holders 9Verification 8Accounts 3
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
6 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Account 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 Account 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 “Close an account holder” (POST /closeAccountHolder), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Account API?
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration… It is listed under Payments and has 20 endpoints.
Who publishes the Account 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 Account API?
Requests go to https://cal-test.adyen.com/cal/services/Account/v6. Endpoint paths are added to this base URL.
How do I authenticate with the Account 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 Account API have?
20 operations on 20 paths (20 POST). The largest groups are Account holders, Verification, Accounts.
Is forking the Account API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.