Account holders7

Authorized card users4

Balance accounts5

Balances5

Bank account validation1

Card orders2

Custom payout schedules (sweeps)5

Direct debit mandates4

Grant accounts1

Grant offers2

Manage card PIN3

Manage SCA devices6

Managed payout schedules8

Network tokens2

Payment instrument groups3

Payment instruments9

Platform3

Recurring top ups4

SCA association management3

SCA device management4

Transaction rules4

Transfer limits - balance account level6

Transfer limits - balance platform level4

Transfer routes1

Account holders

Get an account holder

Returns an account holder.

get/accountHolders/{id}

Path parameters

idstring required

The unique identifier of the account holder.

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

Changed in 8 of the 51 revisions of this API.8276

Sep 9, 2025v2dd6159049c9582See the full diff
- ▲
  the ///// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the //// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the ///// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the //// response property's maxLength was unset from 3 for the response status
  response-property-max-length-unset
- ▲
  the ///// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the //// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the ///// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ▲
  the //// response property's minLength was decreased from 3 to 0 for the response status
  response-property-min-length-decreased
- ●
  added the new dataReview enum value to the //////// response property for the response status
  response-property-enum-value-added
- ●
  added the new dataReview enum value to the ////// response property for the response status
  response-property-enum-value-added
Jan 3, 2025v2de1988a0d7b112See the full diff
- ●
  added the new issueChargeCard enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueChargeCard enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueChargeCard enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueChargeCardCommercial enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueChargeCardCommercial enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueChargeCardCommercial enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCard enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCard enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCard enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCardCommercial enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCardCommercial enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new useChargeCardCommercial enum value to the /// response property for the response status
  response-property-enum-value-added
Oct 10, 2024v280dfacd37eec3See the full diff
- ●
  added the new issueCreditLimit enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueCreditLimit enum value to the ///////// response property for the response status
  response-property-enum-value-added
- ●
  added the new issueCreditLimit enum value to the /// response property for the response status
  response-property-enum-value-added
Apr 26, 2024v26f1fad79c6c01See the full diff
- ○
  removed the inactive enum value from the response property for the response status
  response-property-enum-value-removed
Jan 16, 2024v224691235e7212See the full diff
- ○
  the endpoint scheme security clientKey was added to the API
  api-security-added
- ○
  the response optional property // became read-only for the status
  response-optional-property-became-read-only
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 14, 2023v212a0c6036e6b10See the full diff
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 23, 2023v25f5aad6991852See the full diff
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Aug 9, 2023v2ad8e1da0fe301See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added

Full history