Update an account holder

patch /accountHolders/{id}

Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.

Endpoint destination URL

Click to copy

Path parameters

id string Required

The unique identifier of the account holder.

Request parameters

balancePlatform string

The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.

capabilities object

Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, issueCard for Issuing. The value is an object containing the settings for the capability.

contactDetails object Deprecated

Contact details of the account holder.

description string
Max length: 300

Your description for the account holder, maximum 300 characters.

legalEntityId string Required

The unique identifier of the legal entity associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.

metadata object

A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired.

Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.

primaryBalanceAccount string

The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.

reference string
Max length: 150

Your reference for the account holder, maximum 150 characters.

status string

The status of the account holder.

Possible values:

  • active: The account holder is active. This is the default status when creating an account holder.

  • inactive (Deprecated): The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details.

  • suspended: The account holder is permanently deactivated by Adyen. This action cannot be undone.

  • closed: The account holder is permanently deactivated by you. This action cannot be undone.

timeZone string

The time zone of the account holder. For example, Europe/Amsterdam. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the list of time zone codes.

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
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy