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

The State API from Adyen — 1 operation(s) for state.

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

This API exposes 1 operation across 1 path, and defines 10 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.

1 operations 1 paths 10 schemas 1 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 State 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

State 1
POST
/updateAccountHolderState
Adyen Update Payout or Processing State
post-updateAccountHolderState body → 200202400401403422500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AccountPayoutState (6 properties), AccountHolderStatus (5 properties), AccountProcessingState (5 properties), ServiceError (5 properties). Each schema is shown below with its type and property counts.

ErrorFieldType
object
3 properties
AccountPayoutState
object
6 properties
AccountEvent
object
3 properties
FieldType
object
3 properties
GetAccountHolderStatusResponse
object
5 properties
UpdateAccountHolderStateRequest
object
4 properties 3 required
ServiceError
object
5 properties
AccountProcessingState
object
5 properties
AccountHolderStatus
object
5 properties 1 required
Amount
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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