Returns the details of an account holder.
The code of the account of which to retrieve the details.
Required if no
accountHolderCodeis provided.
The code of the account holder of which to retrieve the details.
Required if no
accountCodeis provided.
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.
The request has succeeded.
Show more Show lessDetails of the account holder.
The address of the account holder.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.
The bank account number (without separators).
Refer to Required information for details on field requirements.
The type of bank account.
Only applicable to bank accounts held in the USA.
The permitted values are: checking, savings.
Refer to Required information for details on field requirements.
The unique identifier (UUID) of the Bank Account.
If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.
If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.
If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.
If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.
The bank identifier code.
Refer to Required information for details on field requirements.
The city in which the bank branch is located.
Refer to Required information for details on field requirements.
The bank code of the banking institution with which the bank account is registered.
Refer to Required information for details on field requirements.
The name of the banking institution with which the bank account is held.
Refer to Required information for details on field requirements.
The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:
Refer to Required information for details on field requirements.
The check code of the bank account.
Refer to Required information for details on field requirements.
The two-letter country code in which the bank account is registered.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The currency in which the bank account deals.
The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
The international bank account number.
The IBAN standard is defined in ISO-13616.
Refer to Required information for details on field requirements.
The city of residence of the bank account owner.
Refer to Required information for details on field requirements.
The country code of the country of residence of the bank account owner.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The date of birth of the bank account owner. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).
The house name or number of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The name of the bank account owner.
Refer to Required information for details on field requirements.
The country code of the country of nationality of the bank account owner.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The postal code of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The state of residence of the bank account owner.
Refer to Required information for details on field requirements.
The street name of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The tax ID number.
Refer to Required information for details on field requirements.
The URL to be used for bank account verification. This may be generated on bank account creation.
Refer to Required information for details on field requirements.
The opaque reference value returned by the Adyen API during bank account login.
Details about the business or nonprofit account holder.
Required when creating an account holder with legalEntity Business or NonProfit.
The registered name of the company (if it differs from the legal name of the company).
Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
Address of the ultimate parent company.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Details about the ultimate parent company's business.
Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to our verification guide.
The address of the person.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Job title of the person. Required when the shareholderType is Controller.
Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.
The name of the person.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Contains information about the person.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
The phone number of the person.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
The unique identifier (UUID) of the shareholder entry.
If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.
If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..
If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.
If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.
Specifies how the person is associated with the account holder.
Possible values:
Owner: Individuals who directly or indirectly own 25% or more of a company.
Controller: Individuals who are members of senior management staff responsible for managing a company or organization.
Signatories associated with the company. Each array entry should represent one signatory.
The address of the person.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Job title of the signatory.
Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.
The name of the person.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Contains information about the person.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
The phone number of the person.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
The unique identifier (UUID) of the signatory.
If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.
If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.
If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.
If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.
The phone number of the account holder provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Details about the individual account holder.
Required when creating an account holder with legalEntity Individual.
The name of the individual.
Make sure your account holder registers using the name shown on their Photo ID.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Personal information of the individual.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
Date when you last reviewed the account holder's information, in ISO-8601 YYYY-MM-DD format. For example, 2020-01-31.
An array containing information about the account holder's legal arrangements.
The address of the legal arrangement.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement. Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.
An array containing information about other entities that are part of the legal arrangement.
The address of the entity.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Required when creating an entity with legalEntityType Business, NonProfit, PublicCompany, or Partnership.
The registered name of the company (if it differs from the legal name of the company).
Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
Address of the ultimate parent company.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Details about the ultimate parent company's business.
Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to our verification guide.
The address of the person.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Job title of the person. Required when the shareholderType is Controller.
Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.
The name of the person.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Contains information about the person.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
The phone number of the person.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
The unique identifier (UUID) of the shareholder entry.
If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.
If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..
If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.
If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.
Specifies how the person is associated with the account holder.
Possible values:
Owner: Individuals who directly or indirectly own 25% or more of a company.
Controller: Individuals who are members of senior management staff responsible for managing a company or organization.
Signatories associated with the company. Each array entry should represent one signatory.
The address of the person.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Job title of the signatory.
Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, Vice President, Executive President, Managing Member, Partner, Treasurer, Director, or Other.
The name of the person.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Contains information about the person.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
The phone number of the person.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
The unique identifier (UUID) of the signatory.
If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.
If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.
If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.
If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.
The phone number of the contact provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
Required when creating an entity with legalEntityType Individual.
The name of the individual.
Make sure your account holder registers using the name shown on their Photo ID.
The name's infix, if applicable.
A maximum length of twenty (20) characters is imposed.
Personal information of the individual.
The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
Array that contains information about the person's identification document. You can submit only one entry per document type.
The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, 2000-01-31.
The country where the document was issued, in the two-character ISO 3166-1 alpha-2 format. For example, NL.
The nationality of the person represented by a two-character country code, in ISO 3166-1 alpha-2 format. For example, NL.
Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.
An array containing the roles of the entity in the legal arrangement.
The possible values depend on the legal arrangement type.
For type Association: ControllingPerson and Shareholder.
For type Partnership: Partner and Shareholder.
For type Trust: Trustee, Settlor, Protector, Beneficiary, and Shareholder.
The legal entity type.
Possible values: Business, Individual, NonProfit, PublicCompany, or Partnership.
The phone number of the entity.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
Your reference for the legal arrangement. Must be between 3 to 128 characters.
The form of legal arrangement. Required if type is Trust or Partnership.
The possible values depend on the type.
For type Trust: CashManagementTrust, CorporateUnitTrust, DeceasedEstate, DiscretionaryInvestmentTrust, DiscretionaryServicesManagementTrust, DiscretionaryTradingTrust, FirstHomeSaverAccountsTrust, FixedTrust, FixedUnitTrust, HybridTrust, ListedPublicUnitTrust, OtherTrust, PooledSuperannuationTrust, PublicTradingTrust, or UnlistedPublicUnitTrust.
For type Partnership: LimitedPartnership, FamilyPartnership, or OtherPartnership
The Merchant Category Code of the account holder.
If not specified in the request, this will be derived from the platform account (which is configured by Adyen).
A set of key and value pairs for general use by the account holder or merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired.
The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to Pay out to cards.
The merchantAccount you used in the /payments request when you saved the account holder's card details.
Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an /updateAccountHolder request.
The recurringDetailReference returned in the /payments response when you saved the account holder's card details.
The shopperReference you sent in the /payments request when you saved the account holder's card details.
The principal business address of the account holder.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen point of sale.
The address of the physical store where the account holder will process payments from.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
The phone number of the store provided as a single string. It will be handled as a landline phone.
Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
The merchant category code (MCC) that classifies the business of the account holder.
The phone number of the store.
The two-character country code of the phone number.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
The phone number.
The inclusion of the phone number country code is not necessary.
The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the virtualAccount is also required. Adyen uses the configuration and the virtualAccount to split funds between accounts in your platform.
The status of the store. Possible values: Pending, Active, Inactive, InactiveWithModifications, Closed.
Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an /updateAccountHolder request.
The name of the account holder's store. This value is shown in shopper statements.
Length: Between 3 to 22 characters
The following characters are not supported: :;}{$#@!|<>%^*+=\
Your unique identifier for the store. The Customer Area also uses this value for the store description.
Length: Between 3 to 128 characters
The following characters are not supported: :;}{$#@!|<>%^*+=\
The account holder's accountCode where the split amount will be sent. Required when you provide the splitConfigurationUUID.
The status of the account holder.
A list of events scheduled for the account holder.
The event.
Permitted values:
InactivateAccount,RefundNotPaidOutTransfers. For more information, refer to Verification checks.
The payout state of the account holder.
Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.
The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the disabled field is true, this field can be used to explain why.
Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, allowPayout will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, allowPayout may or may not be enabled, depending on other factors.
The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
The amount of the transaction, in minor units.
The processing state of the account holder.
The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The status of the account holder.
Permitted values:
Active,Inactive,Suspended,Closed.
A list of the accounts under the account holder.
The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.
The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user.
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.
The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.
The account's payout schedule.
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
Contains field validation errors that would prevent requests from being processed.
The type of error field.
Details of the account holder migrated to the balance platform.
The unique identifier of the balance platfrom to which the account holder was migrated.
Contains the mapping of virtual account codes (classic integration) to the balance account codes (balance platform) associated with the migrated account holder.
Contains the mapping of shareholders associated with the migrated legal entities.
Contains the mapping of business lines and stores associated with the migrated account holder.
The unique identifier of the business line associated with the migrated account holder in the balance platform.
The unique identifier of the store associated with the migrated account holder in the classic integration.
The unique identifier of the store associated with the migrated account holder in the balance platform.
Your reference for the store in the classic integration. The Customer Area uses this value for the store description.
The three-character ISO currency code, with which the prospective account holder primarily deals.
The details of KYC Verification of the account holder.
The results of the checks on the account holder.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The results of the checks on the legal arrangements.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The results of the checks on the legal arrangement entities.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The results of the checks on the payout methods.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The results of the checks on the shareholders.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The unique ID of the legal arrangement to which the shareholder belongs, if applicable.
The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable.
The results of the checks on the signatories.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The result of the check on the Ultimate Parent Company.
A list of the checks and their statuses.
The status of the check.
Possible values: AWAITING_DATA , DATA_PROVIDED, FAILED, INVALID_DATA, PASSED, PENDING, RETRY_LIMIT_REACHED.
A summary of the execution of the check.
The code of the check. For possible values, refer to Verification codes.
The type of check.
Possible values:
BANK_ACCOUNT_VERIFICATION: Used in v5 and earlier. Replaced by PAYOUT_METHOD_VERIFICATION in v6 and later.
COMPANY_VERIFICATION
CARD_VERIFICATION
IDENTITY_VERIFICATION
LEGAL_ARRANGEMENT_VERIFICATION
NONPROFIT_VERIFICATION
PASSPORT_VERIFICATION
PAYOUT_METHOD_VERIFICATION: Used in v6 and later.
PCI_VERIFICATION
The request has been accepted for processing, but the processing has not been completed.
Show more Show lessDetails of the account holder.
The address of the account holder.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.
Array of bank accounts associated with the account holder. For details about the required bankAccountDetail fields, see Required information.
The bank account number (without separators).
Refer to Required information for details on field requirements.
The type of bank account.
Only applicable to bank accounts held in the USA.
The permitted values are: checking, savings.
Refer to Required information for details on field requirements.
The unique identifier (UUID) of the Bank Account.
If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.
If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.
If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.
If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.
The bank identifier code.
Refer to Required information for details on field requirements.
The city in which the bank branch is located.
Refer to Required information for details on field requirements.
The bank code of the banking institution with which the bank account is registered.
Refer to Required information for details on field requirements.
The name of the banking institution with which the bank account is held.
Refer to Required information for details on field requirements.
The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:
Refer to Required information for details on field requirements.
The check code of the bank account.
Refer to Required information for details on field requirements.
The two-letter country code in which the bank account is registered.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The currency in which the bank account deals.
The permitted currency codes are defined in ISO-4217 (e.g. 'EUR').
The international bank account number.
The IBAN standard is defined in ISO-13616.
Refer to Required information for details on field requirements.
The city of residence of the bank account owner.
Refer to Required information for details on field requirements.
The country code of the country of residence of the bank account owner.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The date of birth of the bank account owner. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).
The house name or number of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The name of the bank account owner.
Refer to Required information for details on field requirements.
The country code of the country of nationality of the bank account owner.
The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL').
Refer to Required information for details on field requirements.
The postal code of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The state of residence of the bank account owner.
Refer to Required information for details on field requirements.
The street name of the residence of the bank account owner.
Refer to Required information for details on field requirements.
The tax ID number.
Refer to Required information for details on field requirements.
The URL to be used for bank account verification. This may be generated on bank account creation.
Refer to Required information for details on field requirements.
The opaque reference value returned by the Adyen API during bank account login.
Details about the business or nonprofit account holder.
Required when creating an account holder with legalEntity Business or NonProfit.
The registered name of the company (if it differs from the legal name of the company).
Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
Address of the ultimate parent company.
The name of the city. Required if the houseNumberOrName, street, postalCode, or stateOrProvince are provided.
The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, NL.
The postal code. Required if the houseNumberOrName, street, city, or stateOrProvince are provided.
Maximum length:
5 digits for addresses in the US.
10 characters for all other countries.
The abbreviation of the state or province. Required if the houseNumberOrName, street, city, or postalCode are provided.
Maximum length:
2 characters for addresses in the US or Canada.
3 characters for all other countries.