Adyen Payment API is one of 138 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 Payment. 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 77 schemas.
It is described by OpenAPI 3.2.0, at version 1.
Requests are made against 3 base URLs: https://terminal-api-test.adyen.com/sync, https://terminal-api-test.adyen.com/async,
The identity and technical contract details declared by the specification.
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
PaymentResponse
object
It conveys Information related to the Payment transaction processed by the POI System. Content of the Payment Response message.
7 properties
3 required
PaymentInstrumentType
string
OutputBarcode
object
2 properties
1 required
LoyaltyAcquirerData
object
4 properties
SensitiveCardData
object
This data structure could be CMS protected (EnvelopedData). In this case the data structure SensitiveCardData is replaced by the data structure ProtectedCardDa…
4 properties
AuthenticationMethod
array
StoredValueAccountID
object
It contains the identifications of the stored value account or the stored value card, and the associated product sold by the Sale System for stored value reque…
7 properties
4 required
LoyaltyAmount
object
An awarded amount or an amount to redeem to the loyalty account might be sent in the Payment request message. Amount of a loyalty account.
3 properties
1 required
TransactionConditions
object
Conditions on which the transaction must be processed.
9 properties
AllowedProduct
object
Product that is payable by the payment card. Product codes that are payable by the payment card.
4 properties
1 required
ConvertedAmount
object
2 properties
2 required
LoyaltyAccountID
object
In the Payment or the Loyalty Request message, it allows to identify the loyalty account by the Sale Terminal instead of the POI Terminal (e.g. because the acc…
4 properties
3 required
UTMCoordinates
object
3 properties
3 required
CheckData
object
Allows the check information to be provided by the Sale System before requesting the payment, or stored by the Sale System after processing of the payment. Inf…
7 properties
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
PaymentResult
object
13 properties
PaymentAcquirerData
object
Data related to the response from the payment Acquirer.
6 properties
2 required
TokenRequestedType
string
PaymentRequest
object
Request sent to terminal to initiate payment. It conveys Information related to the Payment transaction to process. Content of the Payment Request message.
4 properties
2 required
CardData
object
Allows acquisition of the card data by the Sale System before the Payment, CardAcquisition or BalanceInquiry request to the POI. It could also be sent in the C…
11 properties
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties
2 required
AmountsReq
object
Amounts of a payment
8 properties
2 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
TrackData
object
ISO 7813 - ISO 4909. Generic data structure for a card track, used when the magstripe card reader is located on the Sale Terminal, or for magstripe Card Reader…
3 properties
1 required
GeographicCoordinates
object
2 properties
2 required
LoyaltyData
object
In the Payment, Loyalty or Balance Inquiry Request message, it allows the Sale Terminal to send the identification of the loyalty account or an awarded amount…
3 properties
IdentificationType
string
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
Geolocation
object
2 properties
PaymentTransaction
object
4 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
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
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
SaleItem
object
In loyalty or value added payment card transaction, the items of the sale are entering in the processing of the transaction. Sale items of a transaction.
11 properties
3 required
MobileData
object
Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.
6 properties
POIData
object
In the Message Response, identification of the POI transaction. Data related to the POI System.
2 properties
1 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
AreaSize
object
2 properties
2 required
Point
object
2 properties
2 required
LoyaltyAccount
object
This data structure conveys the identification of the account and the associated loyalty brand. Data related to a loyalty account processed in the transaction.
2 properties
1 required
PaymentData
object
7 properties
SensitiveMobileData
object
3 properties
1 required
PaymentToken
object
Surrogate of the PAN (Primary Account Number) of the payment card to identify the payment mean of the customer. It allows, for a merchant, to identify the cust…
3 properties
2 required
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties
1 required
SaleItemRebate
object
To be differentiated from the award which is the amount or quantity earned on the loyalty account. The awarded amount that is attached to an item as a rebate.
7 properties
2 required
CapturedSignature
object
2 properties
LoyaltyResult
object
In the Message Response, the result of each loyalty brand transaction. Data related to the result of a processed loyalty transaction.
5 properties
1 required
PaymentInstrumentData
object
Sent in the result of the payment transaction. For a card, it could also be sent in the CardAcquisition response, to be processed by the Sale System. Data rela…
6 properties
1 required
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 properties
1 required
CurrencyConversion
object
A currency conversion occurred in the payment, and the merchant needs to know information related to this conversion (e.g. to print on the sale receipt). Infor…
6 properties
1 required
StoredValueAccountType
string
IdentificationSupport
string
AmountsResp
object
6 properties
1 required
Rebates
object
3 properties
Instalment
object
10 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Adyen publishes across the network.
