Adyen Transactionstatus API
The Transactionstatus API from Adyen — 1 operation(s) for transactionstatus.
Adyen Transactionstatus 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 Transactionstatus. 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 85 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
85 schemas
1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Adyen Transactionstatus 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.
Transactionstatus 1
POST
/transactionstatus
Adyen TransactionStatus Request
Schemas 85
The contract defines 85 schemas that model the data the API accepts and returns. The most detailed are PaymentResult (13 properties), SaleData (12 properties), CardData (11 properties), OutputText (11 properties). Each schema is shown below with its type and property counts.
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
UTMCoordinates
object
3 properties
3 required
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
MessageCategory
string
PeriodUnit
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
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
TransactionStatusResponse
object
It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Response message.
3 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
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
PaymentInstrumentType
string
TokenRequestedType
string
InstalmentType
string
AuthenticationMethod
array
AreaSize
object
2 properties
2 required
RepeatedResponseMessageBody
object
6 properties
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
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
PaymentAcquirerData
object
Data related to the response from the payment Acquirer.
6 properties
2 required
ErrorCondition
string
Point
object
2 properties
2 required
Rebates
object
3 properties
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties
2 required
Result
string
CharacterWidth
string
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
OutputFormat
string
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
PaymentType
string
MessageClass
string
RepeatedMessageResponse
object
2 properties
2 required
TypeCode
string
DocumentQualifier
string
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
StoredValueResponse
object
It conveys Information related to the Stored Value transaction processed by the POI System. Content of the Stored Value Response message.
5 properties
3 required
SensitiveMobileData
object
3 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
CardReaderAPDUResponse
object
It contains the result of the requested service, APDU response sent by the chip of the card in response to the APDU request. Content of the Card Reader APDU Re…
3 properties
2 required
MessageReference
object
To abort a transaction in progress or to request the status of a transaction from which no response has been received. It identifies the message header of the…
5 properties
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
Instalment
object
10 properties
EntryMode
array
StoredValueTransactionType
string
OutputContent
object
This is a sequence of elements if they have different formats. Content to display or print.
5 properties
1 required
IdentificationType
string
BarcodeType
string
UnitOfMeasure
string
Geolocation
object
2 properties
TrackFormat
string
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
TransactionStatusRequest
object
It conveys Information requested for status of the last or current Payment, Loyalty or Reversal transaction. Content of the TransactionStatus Request message.
3 properties
PaymentResult
object
13 properties
PredefinedContent
object
It conveys Information related to the predefined message. Reference of a predefined message to display or print.
2 properties
1 required
LoyaltyResponse
object
It conveys Information related to the Loyalty transaction processed by the POI System. Content of the Loyalty Response message.
5 properties
3 required
MessageHeader
object
It conveys Information related to the Sale to POI protocol management. Message header of the Sale to POI protocol message.
8 properties
5 required
POIData
object
In the Message Response, identification of the POI transaction. Data related to the POI System.
2 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
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
CardAcquisitionResponse
object
It conveys Information related to the payment and loyalty cards read and processed by the POI System and entered by the Customer. Content of the Card Acquisiti…
7 properties
3 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
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
LoyaltyUnit
string
CapturedSignature
object
2 properties
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
AmountsResp
object
6 properties
1 required
GeographicCoordinates
object
2 properties
2 required
Color
string
Alignment
string
MessageType
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
StoredValueResult
object
For each stored value card loaded or reloaded, in the StoredValue response message. Result of loading/reloading a stored value card..
7 properties
1 required
CharacterStyle
string
ConvertedAmount
object
2 properties
2 required
CharacterHeight
string
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
OutputBarcode
object
2 properties
1 required
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
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
MobileData
object
Mobile phone is used as a payment instrument for the transaction. Information related to the mobile for the payment transaction.
6 properties
StoredValueAccountType
string
StoredValueAccountStatus
object
2 properties
1 required
AllowedProduct
object
Product that is payable by the payment card. Product codes that are payable by the payment card.
4 properties
1 required
IdentificationSupport
string
LoyaltyAcquirerData
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Adyen 12
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
#Transactionstatus