Account API

https://cal-test.adyen.com/cal/services/Account/v5
Click to copy

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/v5/createAccountHolder
Trigger verification
Close an account
Close an account holder
Close stores
Create an account
Create an account holder
Delete bank accounts
Delete legal arrangements
Delete payout methods
Delete shareholders
Delete signatories
Get an account holder
Get a tax form
Get documents
Suspend an account holder
Unsuspend an account holder
Update an account
Update an account holder
Update payout or processing state
Upload a document