integrations.sh
← all integrations

adyen.com – AccountService

OpenAPI apis-guru payment

This API is used for the classic integration. If you are just starting your implementation, refer to our 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 .

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 .

Versioning

The Account API supports 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
Homepage
https://api.apis.guru/v2/specs/adyen.com:AccountService/3.json
Provider
adyen.com:AccountService / AccountService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/AccountService/3/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/AccountService/3/openapi.yaml

Tools (19)

Extracted live via the executor SDK.

  • accountHolders.postCloseAccountHolder

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

  • accountHolders.postCreateAccountHolder

    Creates an account holder that 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 .

  • accountHolders.postGetAccountHolder

    Returns the details of an account holder.

  • accountHolders.postGetTaxForm

    Generates a tax form for account holders operating in the US. For more information, refer to .

  • accountHolders.postSuspendAccountHolder

    Changes the to Suspended.

  • accountHolders.postUnSuspendAccountHolder

    Changes the from Suspended to Inactive. Account holders can have a Suspended if you suspend them through the endpoint or if a verification deadline expires.

    You can only unsuspend account holders if they do not have verification checks with a FAILED .

  • accountHolders.postUpdateAccountHolder

    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.

  • accountHolders.postUpdateAccountHolderState

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

  • accounts.postCloseAccount

    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.

  • accounts.postCreateAccount

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

  • accounts.postUpdateAccount

    Updates the description or payout schedule of an account.

  • verification.postDeleteBankAccounts

    Deletes bank accounts associated with an account holder.

  • verification.postDeleteLegalArrangements

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

  • verification.postDeleteShareholders

    Deletes shareholders associated with an account holder.

  • verification.postDeleteSignatories

    Deletes signatories associated with an account holder.

  • verification.postGetUploadedDocuments

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

  • verification.postUploadDocument

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

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools