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

The Reversal API from Adyen — 1 operation(s) for reversal.

Adyen Reversal 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 Reversal. 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 28 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 28 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 Reversal 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.

Reversal 1
POST
/reversal
Adyen Reversal Request
body → 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are SaleData (12 properties), OutputText (11 properties), CustomerOrder (10 properties), OriginalPOITransaction (9 properties). Each schema is shown below with its type and property counts.

POIData
object
In the Message Response, identification of the POI transaction. Data related to the POI System.
2 properties 1 required
ErrorCondition
string
ReversalRequest
object
It conveys Information related to the reversal of a previous payment or a loyalty transaction. Content of the Reversal Request message.
5 properties 2 required
Response
object
If Result is Success, ErrorCondition is absent or not used in the processing of the message. In the other cases, the ErrorCondition has to be present and can r…
3 properties 1 required
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties 2 required
Result
string
CharacterWidth
string
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 properties 1 required
BarcodeType
string
ReversalResponse
object
It conveys Information related to the reversal processed by the POI System. Content of the Reversal Response message.
6 properties 1 required
Color
string
Alignment
string
OutputFormat
string
SaleData
object
Data associated to the Sale System, with a particular value during the processing of the payment by the POI, including the cards acquisition. Data related to t…
12 properties 1 required
CharacterStyle
string
CustomerOrder
object
Customer order attached to a customer, recorded in the POI system. Allows the management of customer orders by the POI, for instance in a multi-channel or a cl…
10 properties 4 required
CharacterHeight
string
OutputBarcode
object
2 properties 1 required
OutputText
object
It conveys Information related to the content of the text message and its format. All the data elements related to the format of the text to display or print a…
11 properties 1 required
PaymentReceipt
object
If the payment receipts are printed by the Sale system and the POI or the Sale does not implement the Print exchange (Basic profile). Customer or Merchant paym…
4 properties 2 required
DocumentQualifier
string
TokenRequestedType
string
OriginalPOITransaction
object
In the Payment or the Loyalty Request message, it allows using the card of a previous CardAcquisition or Payment/Loyalty request. Identification of a previous…
9 properties
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties 1 required
SaleTerminalData
object
In the Login Request, if a Sale Terminal is involved in the login. In other messages, when a logical device is out of order (SaleCapabilites), or when the othe…
1 property
CustomerOrderReq
array
SaleToIssuerData
object
The POI System receives this information and sends it to the Acquirer for the Issuer without any change. Sale information intended for the Issuer.
1 property
ReversalReason
string
Reason of the payment or loyalty reversal..

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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