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`.

7. Account holders-/updateAccountHolder - Update account holder details

POST {{baseUrl}}/updateAccountHolder

Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders. When updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object: * `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs. When updating any field in the following objects, you must submit all the fields required for validation: * `address` * `fullPhoneNumber` * `bankAccountDetails.BankAccountDetail` * `businessDetails.shareholders.ShareholderContact` For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated. To add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.

8. Account holders-/updateAccountHolderState - Update account holder state

POST {{baseUrl}}/updateAccountHolderState

Disables or enables the processing or payout state of an account holder.

9. Verification-/deleteBankAccounts - Delete bank accounts

POST {{baseUrl}}/deleteBankAccounts

Deletes bank accounts associated with an account holder.

10. Verification-/deleteLegalArrangements - Delete legal arrangement entities

POST {{baseUrl}}/deleteLegalArrangements

Deletes legal arrangements and/or legal arrangement entities associated with an account holder.

11. Verification-/deleteShareholders - Delete shareholders

POST {{baseUrl}}/deleteShareholders

Deletes shareholders associated with an account holder.

12. Verification-/deleteSignatories - Delete signatories

POST {{baseUrl}}/deleteSignatories

Deletes signatories associated with an account holder.

13. Verification-/getUploadedDocuments - Get uploaded documents

POST {{baseUrl}}/getUploadedDocuments

Returns documents that were previously uploaded for an account holder. Adyen uses the documents during the verification process.

14. Verification-/uploadDocument - Upload a document

POST {{baseUrl}}/uploadDocument

Uploads a document for an account holder. Adyen uses the documents during the verification process.

15. Accounts-/closeAccount - Close an account

POST {{baseUrl}}/closeAccount

Closes 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 payments are sent to your liable account.

16. Accounts-/createAccount - Add an account to an account holder

POST {{baseUrl}}/createAccount

Creates an account under an account holder. An account holder can have multiple accounts.

17. Accounts-/updateAccount - Set a payout schedule

POST {{baseUrl}}/updateAccount

Updates the description or payout schedule of an account.