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

The balanceAccounts API from Adyen — 5 operation(s) for balanceaccounts.

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

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

9 operations 5 paths 29 schemas 1 DELETE4 GET2 PATCH2 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 balanceAccounts 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 9

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

balanceAccounts 9
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

Schemas 29

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

Expiry
object
2 properties
SweepCounterparty
object
3 properties
BulkAddress
object
9 properties 1 required
Phone
object
2 properties 2 required
JSONObject
object
BalanceSweepConfigurationsResponse
object
3 properties 3 required
PaymentInstrument
object
11 properties 4 required
RestServiceError
object
9 properties 5 required
DeliveryContact
object
6 properties 2 required
BalanceAccount
object
11 properties 2 required
DeliveryAddress
object
7 properties 1 required
CardConfiguration
object
14 properties 1 required
PaginatedPaymentInstrumentsResponse
object
3 properties 3 required
CreateSweepConfigurationV2
object
12 properties 3 required
SweepSchedule
object
2 properties 1 required
PlatformPaymentConfiguration
object
2 properties
IbanAccountIdentification
object
2 properties 2 required
SweepConfigurationV2
object
13 properties 4 required
Authentication
object
3 properties
UpdateSweepConfigurationV2
object
13 properties
Name
object
2 properties 2 required
PhoneNumber
object
3 properties
BalanceAccountInfo
object
8 properties 1 required
Card
object
13 properties 5 required
USLocalAccountIdentification
object
4 properties 3 required
Amount
object
2 properties 2 required
BalanceAccountUpdateRequest
object
7 properties
Balance
object
5 properties 4 required
InvalidField
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-balanceaccounts-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