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

The Balance API from Adyen — 10 operation(s) for balance.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 14 operations across 10 paths, and defines 97 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 10 paths 97 schemas 1 DELETE7 GET2 PATCH4 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 Balance 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 10 paths, the API surfaces 14 operations — 1 DELETE, 7 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Balance 14
POST
/balanceTransfer
Adyen Start a Balance Transfer
post-balanceTransfer body → 200
POST
/paymentMethods/balance
Adyen Get the Balance of a Gift Card
post-paymentMethods-balance 1 param body → 200400401403422500
GET
/accountHolders/{id}/balanceAccounts
Adyen Get All Balance Accounts of an Account Holder
get-accountHolders-id-balanceAccounts 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
/balancePlatforms/{id}
Adyen Get a Balance Platform
get-balancePlatforms-id 1 param → 200400401403422500
GET
/balancePlatforms/{id}/accountHolders
Adyen Get All Account Holders Under a Balance Platform
get-balancePlatforms-id-accountHolders 3 params → 200400401403422500

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are ResponseAdditionalDataCommon (59 properties), BalanceCheckRequest (44 properties), ThreeDS2RequestData (40 properties), AdditionalDataAirline (28 properties). Each schema is shown below with its type and property counts.

ThreeDSRequestorPriorAuthenticationInfo
object
4 properties
SweepCounterparty
object
3 properties
ForexQuote
object
12 properties 2 required
ResponseAdditionalDataNetworkTokens
object
3 properties
AdditionalDataRiskStandalone
object
15 properties
BalanceCheckRequest
object
44 properties 3 required
BalanceCheckResponse
object
7 properties 2 required
Phone_2
object
2 properties 2 required
PaymentInstrument
object
11 properties 4 required
DeliveryContact
object
6 properties 2 required
AdditionalDataWallets
object
6 properties
BalanceAccount
object
11 properties 2 required
CardConfiguration
object
14 properties 1 required
PaginatedPaymentInstrumentsResponse
object
3 properties 3 required
Address
object
6 properties 5 required
AdditionalDataRatepay
object
8 properties
CreateSweepConfigurationV2
object
12 properties 3 required
AdditionalData3DSecure
object
6 properties
PlatformPaymentConfiguration
object
2 properties
AdditionalDataSubMerchant
object
10 properties
ResponseAdditionalDataDomesticError
object
2 properties
ExternalPlatform
object
3 properties
AdditionalDataOpenInvoice
object
18 properties
Card
object
13 properties 5 required
AdditionalDataRetry
object
3 properties
ShopperInteractionDevice
object
3 properties
USLocalAccountIdentification
object
4 properties 3 required
ResponseAdditionalDataBillingAddress
object
6 properties
BalanceAccountUpdateRequest
object
7 properties
BalanceTransferRequest
object
6 properties 4 required
AccountInfo
object
19 properties
VerificationError
object
6 properties
ThreeDSRequestorAuthenticationInfo
object
3 properties
Expiry
object
2 properties
BulkAddress
object
9 properties 1 required
AccountHolder
object
13 properties 2 required
CapabilitySettings
object
5 properties
ContactDetails
object
4 properties 3 required
BrowserInfo
object
9 properties 8 required
CommonField
object
2 properties
RestServiceError
object
9 properties 5 required
ThreeDS2RequestData
object
40 properties 1 required
SplitAmount
object
2 properties 1 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
ResponseAdditionalDataOpi
object
1 property
CapabilityProblemEntity
object
4 properties
AdditionalDataRisk
object
21 properties
AdditionalDataAirline
object
28 properties 1 required
InvalidField
object
3 properties 3 required
Installments
object
2 properties 1 required
VerificationDeadline
object
3 properties 2 required
JSONObject
object
AdditionalDataLodging
object
16 properties
Recurring
object
5 properties
AdditionalDataLevel23
object
17 properties
CapabilityProblemEntity-recursive
object
3 properties
ApplicationInfo
object
6 properties
MerchantDevice
object
3 properties
FraudCheckResult
object
3 properties 3 required
AcctInfo
object
16 properties
DeliveryAddress
object
7 properties 1 required
BalanceTransferResponse
object
9 properties 7 required
SweepSchedule
object
2 properties 1 required
ServiceError
object
6 properties
AdditionalDataCommon
object
16 properties
ResponseAdditionalDataCard
object
8 properties
Name
object
2 properties 2 required
BalanceAccountInfo
object
8 properties 1 required
DeviceRenderOptions
object
2 properties
AdditionalDataTemporaryServices
object
9 properties
ResponseAdditionalDataInstallments
object
12 properties
Amount
object
2 properties 2 required
SDKEphemPubKey
object
4 properties
CapabilityProblem
object
2 properties
Balance
object
5 properties 4 required
AccountSupportingEntityCapability
object
7 properties
Phone
object
2 properties
BalanceSweepConfigurationsResponse
object
3 properties 3 required
PaginatedBalanceAccountsResponse
object
3 properties 3 required
AdditionalDataCarRental
object
23 properties
FraudResult
object
2 properties 1 required
AccountHolderCapability
object
10 properties
BalanceAccountBase
object
10 properties 2 required
AdditionalDataOpi
object
1 property
MerchantRiskIndicator
object
14 properties
PaginatedAccountHoldersResponse
object
3 properties 3 required
BalancePlatform
object
3 properties 1 required
ResponseAdditionalDataSepa
object
3 properties
ResponseAdditionalData3DSecure
object
5 properties
ResponseAdditionalDataCommon
object
59 properties
Split
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-balance-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 Accounts 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
#Balance
← Back to A APIs
API Details
ID
adyen:adyen-balance-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