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 accountHolders API

The accountHolders API from Adyen — 4 operation(s) for accountholders.

Adyen accountHolders 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 accountHolders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 5 operations across 4 paths, and defines 24 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.

5 operations 4 paths 24 schemas 3 GET1 PATCH1 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 accountHolders 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 5

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

accountHolders 5
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

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are AccountHolder (13 properties), AccountHolderUpdateRequest (11 properties), AccountHolderCapability (10 properties), BalanceAccountBase (10 properties). Each schema is shown below with its type and property counts.

AccountSupportingEntityCapability
object
7 properties
GetTaxFormResponse
object
2 properties 1 required
Phone
object
2 properties 2 required
AccountHolder
object
13 properties 2 required
VerificationDeadline
object
3 properties 2 required
JSONObject
object
PaginatedBalanceAccountsResponse
object
3 properties 3 required
CapabilitySettings
object
5 properties
ContactDetails
object
4 properties 3 required
CapabilityProblemEntity-recursive
object
3 properties
RestServiceError
object
9 properties 5 required
AccountHolderInfo
object
9 properties 1 required
Address
object
6 properties 5 required
AccountHolderCapability
object
10 properties
BalanceAccountBase
object
10 properties 2 required
PlatformPaymentConfiguration
object
2 properties
VerificationError-recursive
object
5 properties
AccountHolderUpdateRequest
object
11 properties
RemediatingAction
object
2 properties
CapabilityProblemEntity
object
4 properties
Amount
object
2 properties 2 required
CapabilityProblem
object
2 properties
InvalidField
object
3 properties 3 required
VerificationError
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-accountholders-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance 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
Adyen Arrangements API