Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters.
For example, to limit the page to 5 account holders and to skip the first 20, use /balancePlatforms/{id}/accountHolders?limit=5&offset=20.
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 lessList of account holders.
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.
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.
Indicates whether the capability is allowed. Adyen sets this to true if the verification is successful and the account holder is permitted to use the capability.
The capability level that is allowed for the account holder.
Possible values: notApplicable, low, medium, high.
A JSON object containing the settings that are allowed for the account holder.
The amount of the transaction, in minor units.
The amount of the transaction, in minor units.
Indicates whether the capability is enabled. If false, the capability is temporarily disabled for the account holder.
Contains verification errors and the actions that you can take to resolve them.
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the allowed field.
The requested level of the capability. Some capabilities, such as those used in card issuing, have different levels. Levels increase the capability, but also require additional checks and increased monitoring.
Possible values: notApplicable, low, medium, high.
A JSON object containing the settings that were requested for the account holder.
The amount of the transaction, in minor units.
The amount of the transaction, in minor units.
Contains the status of the transfer instruments associated with this capability.
Indicates whether the supporting entity capability is allowed. Adyen sets this to true if the verification is successful and the account holder is permitted to use the capability.
The capability level that is allowed for the account holder.
Possible values: notApplicable, low, medium, high.
Indicates whether the capability is enabled. If false, the capability is temporarily disabled for the account holder.
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the allowed field.
The requested level of the capability. Some capabilities, such as those used in card issuing, have different levels. Levels increase the capability, but also require additional checks and increased monitoring.
Possible values: notApplicable, low, medium, high.
The status of the verification checks for the supporting entity capability.
Possible values:
pending: Adyen is running the verification.
invalid: The verification failed. Check if the errors array contains more information.
valid: The verification has been successfully completed.
rejected: Adyen has verified the information, but found reasons to not allow the capability.
The status of the verification checks for the capability.
Possible values:
pending: Adyen is running the verification.
invalid: The verification failed. Check if the errors array contains more information.
valid: The verification has been successfully completed.
rejected: Adyen has verified the information, but found reasons to not allow the capability.
Contact details of the account holder.
The address of the account holder.
The two-character ISO-3166-1 alpha-2 country code. For example, US.
If you don't know the country or are not collecting the country from the shopper, provide
countryasZZ.
The number or name of the house. Maximum length: 3000 characters.
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.
Required for the US and Canada.
The phone number of the account holder.
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.
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 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.
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.
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.
List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.