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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Adyen

Adyen Accounts API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 22 operations across 17 paths, and defines 84 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.

22 operations 17 paths 84 schemas 1 DELETE8 GET3 PATCH10 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
Contact
Adyen Developer Experience team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Adyen Accounts 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 22

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

Accounts 22
POST
/checkAccountHolder
Adyen Trigger Verification
post-checkAccountHolder body → 200202400401403422500
POST
/closeAccount
Adyen Close an Account
post-closeAccount body → 200202400401403422500
POST
/closeAccountHolder
Adyen Close an Account Holder
post-closeAccountHolder body → 200202400401403422500
POST
/deleteBankAccounts
Adyen Delete Bank Accounts
post-deleteBankAccounts 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
/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 84

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

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

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
AE Profile APIs.io
Adyen Account API
AE Profile APIs.io
Adyen accountHolderBalance API
AE Profile APIs.io
Adyen accountHolders API
AE Profile APIs.io
Adyen accountHolderTransactionList API
AE Profile APIs.io
Adyen Accounting Notifications API
AE Profile APIs.io
Adyen adjustAuthorisation API
AE Profile APIs.io
Adyen Admin API
AE Profile APIs.io
Adyen Amount API
AE Profile APIs.io
Adyen Apple API
AE Profile APIs.io
Adyen applePay API
AE Profile APIs.io
Adyen Arrangements API
AE Profile APIs.io
#Accounts
← Back to A APIs
API Details
ID
adyen:adyen-accounts-api
Base URL
https://cal-test.adyen.com
Docs
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
Provider
Adyen
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network