ADadyen
Account holders

Create an account holder

Changed on

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.

post/createAccountHolder

Request

  • Base URL
    https://cal-test.adyen.com/cal/services/Account/v5
  • URL
    https://cal-test.adyen.com/cal/services/Account/v5/createAccountHolder
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

accountHolderCodestring required

Your unique identifier for the prospective account holder. The length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.

createDefaultAccountboolean

If set to true, an account with the default options is automatically created for the account holder. By default, this field is set to true.

descriptionstring

A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.

legalEntity'Business' | 'Individual' | 'NonProfit' required

The legal entity type of the account holder. This determines the information that should be provided in the request.

Possible values: Business, Individual, or NonProfit.

  • If set to Business or NonProfit, then accountHolderDetails.businessDetails must be provided, with at least one entry in the accountHolderDetails.businessDetails.shareholders list.

  • If set to Individual, then accountHolderDetails.individualDetails must be provided.

primaryCurrencystring

The three-character ISO currency code, with which the prospective account holder primarily deals.

processingTierinteger

The starting processing tier for the prospective account holder.

Response

OK - the request has succeeded.

accountCodestring

The code of a new account created for the account holder.

accountHolderCodestring

The code of the new account holder.

descriptionstring

The description of the new account holder.

legalEntity'Business' | 'Individual' | 'NonProfit'

The type of legal entity of the new account holder.

primaryCurrencystring

The three-character ISO currency code, with which the prospective account holder primarily deals.

pspReferencestring

The reference of a request. Can be used to uniquely identify the request.

resultCodestring

The result code.

Changes

  • v506cbe90ffec2Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • v5a94da11458a5Revision changes
    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status