Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Holders API

The Holders API from Adyen — 13 operation(s) for holders.

Adyen Holders API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Holders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 14 operations across 13 paths, and defines 81 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

14 operations 13 paths 81 schemas 4 GET1 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Holders API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 14

Across 13 paths, the API surfaces 14 operations — 4 GET, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Holders 14
POST
/checkAccountHolder
Adyen Trigger Verification
post-checkAccountHolder body → 200202400401403422500
POST
/closeAccountHolder
Adyen Close an Account Holder
post-closeAccountHolder body → 200202400401403422500
POST
/createAccountHolder
Adyen Create an Account Holder
post-createAccountHolder body → 200400401403422500
POST
/getAccountHolder
Adyen Get an Account Holder
post-getAccountHolder body → 200202400401403422500
POST
/suspendAccountHolder
Adyen Suspend an Account Holder
post-suspendAccountHolder body → 200202400401403422500
POST
/unSuspendAccountHolder
Adyen Unsuspend an Account Holder
post-unSuspendAccountHolder body → 200202400401403422500
POST
/updateAccountHolder
Adyen Update an Account Holder
post-updateAccountHolder body → 200202400401403422500
POST
/updateAccountHolderState
Adyen Update Payout or Processing State
post-updateAccountHolderState body → 200202400401403422500
POST
/accountHolders
Adyen Create an Account Holder
post-accountHolders body → 200400401403422500
GET
/accountHolders/{id}
Adyen Get an Account Holder
get-accountHolders-id 1 param → 200400401403422500
PATCH
/accountHolders/{id}
Adyen Update an Account Holder
patch-accountHolders-id 1 param body → 200400401403422500
GET
/accountHolders/{id}/balanceAccounts
Adyen Get All Balance Accounts of an Account Holder
get-accountHolders-id-balanceAccounts 3 params → 200400401403422500
GET
/accountHolders/{id}/taxForms
Adyen Get a Tax Form
get-accountHolders-id-taxForms 3 params → 200400401403422500
GET
/balancePlatforms/{id}/accountHolders
Adyen Get All Account Holders Under a Balance Platform
get-balancePlatforms-id-accountHolders 3 params → 200400401403422500

Schemas 81

The contract defines 81 schemas that model the data the API accepts and returns. The most detailed are BankAccountDetail (26 properties), AccountHolderDetails (15 properties), StoreDetail (15 properties), GetAccountHolderResponse (14 properties). Each schema is shown below with its type and property counts.

LegalArrangementEntityDetail
object
11 properties
AccountPayoutState
object
6 properties
KYCLegalArrangementCheckResult
object
2 properties
BankAccountDetail
object
26 properties
AccountHolderInfo
object
9 properties 1 required
SignatoryContact
object
10 properties
Address
object
6 properties 5 required
PlatformPaymentConfiguration
object
2 properties
GetAccountHolderRequest
object
3 properties
PayoutScheduleResponse
object
2 properties
KYCLegalArrangementEntityCheckResult
object
3 properties
SuspendAccountHolderRequest
object
1 property 1 required
AccountHolderDetails
object
15 properties 1 required
CloseAccountHolderResponse
object
4 properties
AccountHolderStatus
object
5 properties 1 required
UnSuspendAccountHolderResponse
object
4 properties
KYCShareholderCheckResult
object
4 properties
VerificationError
object
6 properties
StoreDetail
object
15 properties 3 required
AccountHolder
object
13 properties 2 required
Account
object
10 properties
GenericResponse
object
3 properties
PerformVerificationRequest
object
3 properties 3 required
CapabilitySettings
object
5 properties
ViasPhoneNumber
object
3 properties
ContactDetails
object
4 properties 3 required
MigratedShareholders
object
2 properties
UltimateParentCompany
object
3 properties
RestServiceError
object
9 properties 5 required
MigrationData
object
7 properties
IndividualDetails
object
2 properties
UltimateParentCompanyBusinessDetails
object
5 properties
KYCSignatoryCheckResult
object
2 properties
KYCCheckResult
object
1 property
LegalArrangementDetail
object
9 properties 3 required
VerificationError-recursive
object
5 properties
ViasName
object
4 properties
RemediatingAction
object
2 properties
UnSuspendAccountHolderRequest
object
1 property 1 required
AccountEvent
object
3 properties
CapabilityProblemEntity
object
4 properties
BusinessDetails
object
10 properties
KYCCheckSummary
object
2 properties
InvalidField
object
3 properties 3 required
SuspendAccountHolderResponse
object
4 properties
GetTaxFormResponse
object
2 properties 1 required
ShareholderContact
object
11 properties
VerificationDeadline
object
3 properties 2 required
JSONObject
object
KYCVerificationResult
object
7 properties
ErrorFieldType
object
3 properties
CapabilityProblemEntity-recursive
object
3 properties
PayoutMethod
object
5 properties 3 required
UpdateAccountHolderRequest
object
7 properties 1 required
CreateAccountHolderRequest
object
8 properties 3 required
ServiceError
object
5 properties
AccountHolderUpdateRequest
object
11 properties
FieldType
object
3 properties
MigratedStores
object
4 properties
UpdateAccountHolderResponse
object
11 properties
Amount
object
2 properties 2 required
ViasAddress
object
6 properties 1 required
ViasPersonalData
object
3 properties
CapabilityProblem
object
2 properties
AccountSupportingEntityCapability
object
7 properties
UpdateAccountHolderStateRequest
object
4 properties 3 required
MigratedAccounts
object
2 properties
Phone
object
2 properties 2 required
PersonalDocumentData
object
5 properties 1 required
KYCUltimateParentCompanyCheckResult
object
2 properties
PaginatedBalanceAccountsResponse
object
3 properties 3 required
GetAccountHolderStatusResponse
object
5 properties
AccountHolderCapability
object
10 properties
KYCCheckStatusData
object
4 properties 2 required
BalanceAccountBase
object
10 properties 2 required
CloseAccountHolderRequest
object
1 property 1 required
PaginatedAccountHoldersResponse
object
3 properties 3 required
GetAccountHolderResponse
object
14 properties
AccountProcessingState
object
5 properties
KYCPayoutMethodCheckResult
object
2 properties
CreateAccountHolderResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-holders-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API