ADadyen
Account holders

Create an account holder

Changed on

Creates an account holder linked to a legal entity.

post/accountHolders

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

Request body

balancePlatformstring

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.

capabilitiesobject

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.

descriptionstring

Your description for the account holder.

legalEntityIdstring 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.

metadataobject

A set of key and value pairs for general use. 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.

migratedAccountHolderCodestring

The unique identifier of the migrated account holder in the classic integration.

referencestring

Your reference for the account holder.

timeZonestring

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

OK - the request has succeeded.

balancePlatformstring

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.

capabilitiesobject

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.

descriptionstring

Your description for the account holder.

idstring required

The unique identifier of the account holder.

legalEntityIdstring 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.

metadataobject

A set of key and value pairs for general use. 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.

migratedAccountHolderCodestring

The unique identifier of the migrated account holder in the classic integration.

primaryBalanceAccountstring

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.

referencestring

Your reference for the account holder.

status'active' | 'closed' | 'suspended'

The status of the account holder.

Possible values:

  • active: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to suspended or closed.

  • suspended: The account holder is temporarily disabled and payouts are blocked. You can change this status to active or closed.

  • closed: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.

timeZonestring

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.

Changes

  • v2dd6159049c95Revision changes
    • breaking

      the ///// response property's maxLength was unset from 3 for the response status

    • breaking

      the //// response property's maxLength was unset from 3 for the response status

    • breaking

      the ///// response property's maxLength was unset from 3 for the response status

    • breaking

      the //// response property's maxLength was unset from 3 for the response status

    • breaking

      the ///// response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the //// response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the ///// response property's minLength was decreased from 3 to 0 for the response status

    • breaking

      the //// response property's minLength was decreased from 3 to 0 for the response status

    • warning

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

    • warning

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

    • info

      added the new dataReview enum value to the request property ////////

    • info

      added the new dataReview enum value to the request property //////

    • info

      the ///// request property's minLength was decreased from 3 to 0

    • info

      the //// request property's minLength was decreased from 3 to 0

    • info

      the ///// request property's minLength was decreased from 3 to 0

    • info

      the //// request property's minLength was decreased from 3 to 0

  • v2de1988a0d7b1Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

      added the new issueChargeCard enum value to the request property ///////

    • info

      added the new issueChargeCard enum value to the request property /////////

    • info

      added the new issueChargeCardCommercial enum value to the request property ///////

    • info

      added the new issueChargeCardCommercial enum value to the request property /////////

    • info

      added the new useChargeCard enum value to the request property ///////

    • info

      added the new useChargeCard enum value to the request property /////////

    • info

      added the new useChargeCardCommercial enum value to the request property ///////

    • info

      added the new useChargeCardCommercial enum value to the request property /////////