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

The Close API from Adyen — 3 operation(s) for close.

Adyen Close 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 Close. 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 14 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.

3 operations 3 paths 14 schemas 3 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 Close 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 3

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

Close 3
POST
/closeAccount
Adyen Close an Account
post-closeAccount body → 200202400401403422500
POST
/closeAccountHolder
Adyen Close an Account Holder
post-closeAccountHolder body → 200202400401403422500
POST
/closeStores
Adyen Close Stores
post-closeStores body → 200400401403422500

Schemas 14

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

CloseAccountResponse
object
5 properties
ErrorFieldType
object
3 properties
AccountPayoutState
object
6 properties
AccountEvent
object
3 properties
FieldType
object
3 properties
CloseAccountRequest
object
1 property 1 required
CloseStoresRequest
object
2 properties 2 required
AccountProcessingState
object
5 properties
CloseAccountHolderResponse
object
4 properties
AccountHolderStatus
object
5 properties 1 required
GenericResponse
object
3 properties
Amount
object
2 properties 2 required
ServiceError
object
5 properties
CloseAccountHolderRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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