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

The balancePlatforms API from Adyen — 2 operation(s) for balanceplatforms.

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

This API exposes 2 operations across 2 paths, and defines 20 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.

2 operations 2 paths 20 schemas 2 GET

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 balancePlatforms 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 2

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

balancePlatforms 2
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 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AccountHolder (13 properties), AccountHolderCapability (10 properties), RestServiceError (9 properties), AccountSupportingEntityCapability (7 properties). Each schema is shown below with its type and property counts.

AccountSupportingEntityCapability
object
7 properties
Phone
object
2 properties 2 required
AccountHolder
object
13 properties 2 required
VerificationDeadline
object
3 properties 2 required
JSONObject
object
CapabilitySettings
object
5 properties
ContactDetails
object
4 properties 3 required
CapabilityProblemEntity-recursive
object
3 properties
RestServiceError
object
9 properties 5 required
Address
object
6 properties 5 required
AccountHolderCapability
object
10 properties
VerificationError-recursive
object
5 properties
RemediatingAction
object
2 properties
PaginatedAccountHoldersResponse
object
3 properties 3 required
BalancePlatform
object
3 properties 1 required
CapabilityProblemEntity
object
4 properties
Amount
object
2 properties 2 required
CapabilityProblem
object
2 properties
InvalidField
object
3 properties 3 required
VerificationError
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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