Update an account holder

post /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.

Endpoint destination URL

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

Request parameters

accountHolderCode string Required

The code of the Account Holder to be updated.

accountHolderDetails

The details to which the Account Holder should be updated.

Required if a processingTier is not provided.

description string

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

legalEntity string

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.

primaryCurrency string Deprecated

The primary three-character ISO currency code, to which the account holder should be updated.

processingTier integer

The processing tier to which the Account Holder should be updated.

The processing tier can not be lowered through this request.

Required if accountHolderDetails are not provided.

verificationProfile string

The identifier of the profile that applies to this entity.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less