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

Need help?

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

This API exposes 3 operations across 3 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://pal-test.adyen.com/pal/servlet/BalanceControl/v1, https://checkout-test.adyen.com/v71, https://balanceplatform-api-test.adyen.com/bcl/v2.

3 operations 3 paths 58 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic, API Key
Contact
Adyen Developer Experience team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

Adyen Balance 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 3

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

Balance 3
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
/balancePlatforms/{id}
Adyen Get a Balance Platform
get-balancePlatforms-id 1 param → 200400401403422500

Schemas 58

The contract defines 58 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.

BalanceTransferResponse
object
9 properties 7 required
BalanceTransferRequest
object
6 properties 4 required
Amount
object
2 properties 2 required
ServiceError
object
6 properties
AdditionalData3DSecure
object
6 properties
MerchantDevice
object
3 properties
ResponseAdditionalDataSepa
object
3 properties
Installments
object
2 properties 1 required
AdditionalDataRiskStandalone
object
15 properties
AcctInfo
object
16 properties
ResponseAdditionalDataNetworkTokens
object
3 properties
AdditionalDataCarRental
object
23 properties
ResponseAdditionalDataBillingAddress
object
6 properties
Name
object
2 properties 2 required
ResponseAdditionalDataCommon
object
59 properties
AdditionalDataRatepay
object
8 properties
ExternalPlatform
object
3 properties
ResponseAdditionalDataCard
object
8 properties
AdditionalDataCommon
object
16 properties
AdditionalDataRetry
object
3 properties
ShopperInteractionDevice
object
3 properties
AdditionalDataOpenInvoice
object
18 properties
Split
object
5 properties 1 required
SplitAmount
object
2 properties 1 required
AdditionalDataSubMerchant
object
10 properties
Recurring
object
5 properties
Phone
object
2 properties
ThreeDS2RequestData
object
40 properties 1 required
AccountInfo
object
19 properties
ForexQuote
object
12 properties 2 required
DeviceRenderOptions
object
2 properties
ResponseAdditionalData3DSecure
object
5 properties
AdditionalDataAirline
object
28 properties 1 required
ResponseAdditionalDataDomesticError
object
2 properties
BrowserInfo
object
9 properties 8 required
MerchantRiskIndicator
object
14 properties
FraudCheckResult
object
3 properties 3 required
Address
object
6 properties 5 required
AdditionalDataTemporaryServices
object
9 properties
FraudResult
object
2 properties 1 required
AdditionalDataRisk
object
21 properties
CommonField
object
2 properties
ResponseAdditionalDataOpi
object
1 property
ThreeDSRequestorAuthenticationInfo
object
3 properties
ResponseAdditionalDataInstallments
object
12 properties
AdditionalDataWallets
object
6 properties
BalanceCheckRequest
object
44 properties 3 required
ApplicationInfo
object
6 properties
AdditionalDataLodging
object
16 properties
SDKEphemPubKey
object
4 properties
BalanceCheckResponse
object
7 properties 2 required
AdditionalDataOpi
object
1 property
ThreeDSRequestorPriorAuthenticationInfo
object
4 properties
AdditionalDataLevel23
object
17 properties
BalancePlatform
object
3 properties 1 required
InvalidField
object
3 properties 3 required
RestServiceError
object
9 properties 5 required
JSONObject
object

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 accountHolderTransactionList 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 assignTerminals API
AE Profile APIs.io
Adyen Authorise API
AE Profile APIs.io
Adyen Authorise3d API
AE Profile APIs.io
#Balances
← 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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=adyen-balance-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/adyen-balance-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Adyen Balance 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.