Account API 3 [2023-02-07] Copy
Number of APIs: 17
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/v3/createAccountHolder
1. Account holders-/closeAccountHolder - Close an account holder
POST {{baseUrl}}/closeAccountHolder
Changes 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 reopen it. If payments are made to an account of an account holder with a Closed `status`, the payments are sent to your liable account.
2. Account holders-/createAccountHolder - Create an individual account holder
POST {{baseUrl}}/createAccountHolder
Creates 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 sub-merchant's legal entity type. For more information, refer to Account holder and accounts.
3. Account holders-/getAccountHolder - Get an account holder for the account
POST {{baseUrl}}/getAccountHolder
Returns the details of an account holder.
4. Account holders-/getTaxForm - Get a tax form
POST {{baseUrl}}/getTaxForm
Generates a tax form for account holders operating in the US. For more information, refer to Providing tax forms.
5. Account holders-/suspendAccountHolder - Suspend an account holder
POST {{baseUrl}}/suspendAccountHolder
Changes the status of an account holder to Suspended.
6. Account holders-/unSuspendAccountHolder - Unsuspend an account holder
POST {{baseUrl}}/unSuspendAccountHolder
Changes the status of an account holder from Suspended to Inactive. Account holders can have a Suspended `status` if you suspend them through the `/suspendAccountHolder` endpoint or if a verification deadline expires. You can only unsuspend account holders if they do not have verification checks with a FAILED `status`.
ENDPOINTS