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

The Suspend API from Adyen — 2 operation(s) for suspend.

Adyen Suspend 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 Suspend. 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 12 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 12 schemas 2 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 Suspend 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 POST. Each is listed below with its method, path, parameters, and response codes.

Suspend 2
POST
/suspendAccountHolder
Adyen Suspend an Account Holder
post-suspendAccountHolder body → 200202400401403422500
POST
/unSuspendAccountHolder
Adyen Unsuspend an Account Holder
post-unSuspendAccountHolder body → 200202400401403422500

Schemas 12

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

ErrorFieldType
object
3 properties
SuspendAccountHolderRequest
object
1 property 1 required
AccountPayoutState
object
6 properties
AccountEvent
object
3 properties
FieldType
object
3 properties
UnSuspendAccountHolderRequest
object
1 property 1 required
AccountProcessingState
object
5 properties
Amount
object
2 properties 2 required
AccountHolderStatus
object
5 properties 1 required
UnSuspendAccountHolderResponse
object
4 properties
ServiceError
object
5 properties
SuspendAccountHolderResponse
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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