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

The Cancels API from Adyen — 3 operation(s) for cancels.

Adyen Cancels 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 Cancels. 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 13 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 13 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 Cancels 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.

Cancels 3
POST
/cancels
Adyen Cancel an Authorised Payment
post-cancels 1 param body → 201400401403422500
POST
/orders/cancel
Adyen Cancel an Order
post-orders-cancel 1 param body → 200400401403422500
POST
/payments/{paymentPspReference}/cancels
Adyen Cancel an Authorised Payment
post-payments-paymentPspReference-cancels 2 params body → 201400401403422500

Schemas 13

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

PaymentCancelResponse
object
5 properties 4 required
CancelOrderRequest
object
2 properties 2 required
CancelOrderResponse
object
2 properties 2 required
StandalonePaymentCancelResponse
object
5 properties 4 required
ApplicationInfo
object
6 properties
CommonField
object
2 properties
MerchantDevice
object
3 properties
StandalonePaymentCancelRequest
object
4 properties 2 required
EncryptedOrderData
object
2 properties 2 required
ServiceError
object
6 properties
ExternalPlatform
object
3 properties
ShopperInteractionDevice
object
3 properties
PaymentCancelRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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