How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adyen Accounts API

The Accounts API from Adyen — 17 operation(s) for accounts.

Adyen Accounts API is one of 138 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 Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 16 operations across 11 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, https://balanceplatform-api-test.adyen.com/bcl/v2.

16 operations 11 paths 66 schemas 1 DELETE8 GET3 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 3

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

Paths & Operations 16

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

Accounts 16
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
POST
/balanceAccounts
Adyen Create a Balance Account
post-balanceAccounts body → 200400401403422500
GET
/balanceAccounts/{balanceAccountId}/sweeps
Adyen Get All Sweeps for a Balance Account
get-balanceAccounts-balanceAccountId-sweeps 3 params → 200400401403422500
POST
/balanceAccounts/{balanceAccountId}/sweeps
Adyen Create a Sweep
post-balanceAccounts-balanceAccountId-sweeps 1 param body → 200400401403422500
DELETE
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Delete a Sweep
delete-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params → 204400401403422500
GET
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Get a Sweep
get-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params → 200400401403422500
PATCH
/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}
Adyen Update a Sweep
patch-balanceAccounts-balanceAccountId-sweeps-sweepId 2 params body → 200400401403422500
GET
/balanceAccounts/{id}
Adyen Get a Balance Account
get-balanceAccounts-id 1 param → 200400401403422500
PATCH
/balanceAccounts/{id}
Adyen Update a Balance Account
patch-balanceAccounts-id 1 param body → 200400401403422500
GET
/balanceAccounts/{id}/paymentInstruments
Adyen Get Payment Instruments Linked to a Balance Account
get-balanceAccounts-id-paymentInstruments 4 params → 200400401403422500
GET
/grantAccounts/{id}
Adyen Get a Grant Account
get-grantAccounts-id 1 param → 200400401403422500
POST
/validateBankAccountIdentification
Adyen Validate a Bank Account
post-validateBankAccountIdentification body → 200401403422500

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are CardConfiguration (14 properties), SweepConfigurationV2 (13 properties), Card (13 properties), AccountHolder (13 properties). Each schema is shown below with its type and property counts.

PlatformPaymentConfiguration
object
2 properties
AccountSupportingEntityCapability
object
7 properties
Expiry
object
2 properties
NOLocalAccountIdentification
object
2 properties 2 required
VerificationError
object
6 properties
CardConfiguration
object
14 properties 1 required
BalanceSweepConfigurationsResponse
object
3 properties 3 required
BalanceAccountInfo
object
8 properties 1 required
DKLocalAccountIdentification
object
3 properties 3 required
AccountHolderCapability
object
10 properties
Authentication
object
3 properties
BalanceAccount
object
11 properties 2 required
SweepSchedule
object
2 properties 1 required
CapitalGrantAccount
object
4 properties
SweepCounterparty
object
3 properties
DeliveryContact
object
6 properties 2 required
GrantLimit
object
1 property
InvalidField
object
3 properties 3 required
SweepConfigurationV2
object
13 properties 4 required
Name
object
2 properties 2 required
Amount
object
2 properties 2 required
PaginatedBalanceAccountsResponse
object
3 properties 3 required
AdditionalBankIdentification
object
2 properties
DeliveryAddress
object
7 properties 1 required
USLocalAccountIdentification
object
4 properties 3 required
AccountHolder
object
13 properties 2 required
BalanceAccountBase
object
10 properties 2 required
PLLocalAccountIdentification
object
2 properties 2 required
Address
object
6 properties 5 required
Card
object
13 properties 5 required
RemediatingAction
object
2 properties
VerificationDeadline
object
3 properties 2 required
Phone
object
2 properties 2 required
RestServiceError
object
9 properties 5 required
CapabilityProblemEntity-recursive
object
3 properties
AccountHolderInfo
object
9 properties 1 required
BulkAddress
object
9 properties 1 required
JSONObject
object
PaymentInstrument
object
11 properties 4 required
BalanceAccountUpdateRequest
object
7 properties
HKLocalAccountIdentification
object
3 properties 3 required
VerificationError-recursive
object
5 properties
UKLocalAccountIdentification
object
3 properties 3 required
NZLocalAccountIdentification
object
2 properties 2 required
CALocalAccountIdentification
object
5 properties 4 required
PhoneNumber
object
3 properties
UpdateSweepConfigurationV2
object
13 properties
BRLocalAccountIdentification
object
4 properties 4 required
PaginatedPaymentInstrumentsResponse
object
3 properties 3 required
IbanAccountIdentification
object
2 properties 2 required
Balance
object
5 properties 4 required
SELocalAccountIdentification
object
3 properties 3 required
NumberAndBicAccountIdentification
object
4 properties 3 required
AULocalAccountIdentification
object
3 properties 3 required
CapabilityProblemEntity
object
4 properties
AccountHolderUpdateRequest
object
11 properties
SGLocalAccountIdentification
object
3 properties 2 required
CreateSweepConfigurationV2
object
12 properties 3 required
GetTaxFormResponse
object
2 properties 1 required
CapabilityProblem
object
2 properties
ContactDetails
object
4 properties 3 required
HULocalAccountIdentification
object
2 properties 2 required
CZLocalAccountIdentification
object
3 properties 3 required
BankAccountIdentificationValidationRequest
object
1 property 1 required
CapitalBalance
object
4 properties 4 required
CapabilitySettings
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-accounts-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolderTransactionList API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen assignTerminals API
Adyen Authorise API
Adyen Authorise3d API
Adyen Authorise3ds2 API
Where this information came from

This is an independent, third-party profile of Adyen Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.