Adyen Cardacquisition 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 Cardacquisition. 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 39 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 operations1 paths39 schemas1 POST
Metadata
The identity and technical contract details declared by the specification.
Adyen Cardacquisition 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.
Cardacquisition 1
POST
/cardacquisition
Adyen CardAcquisition Request
body→ 200
Schemas 39
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are SaleData (12 properties), CardData (11 properties), CustomerOrder (10 properties), CardAcquisitionTransaction (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 properties1 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 properties1 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 properties3 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 properties3 required
ErrorCondition
string
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 properties3 required
EntryMode
array
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 properties1 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 properties4 required
TransactionIDType
object
Identification of a transaction for the Sale System or the POI System.
2 properties2 required
Result
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
GeographicCoordinates
object
2 properties2 required
IdentificationType
string
CardAcquisitionTransaction
object
9 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 properties1 required
PaymentType
string
Geolocation
object
2 properties
CardAcquisitionRequest
object
It conveys Information related to the payment and loyalty cards to read and analyse. This message pair is usually followed by a message pair (e.g. payment or l…
2 properties2 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 properties4 required
TrackFormat
string
TypeCode
string
ForceEntryMode
array
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 properties1 required
PaymentInstrumentType
string
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
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 properties2 required
TokenRequestedType
string
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
SensitiveMobileData
object
3 properties1 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
AllowedProduct
object
Product that is payable by the payment card. Product codes that are payable by the payment card.
4 properties1 required
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
LoyaltyHandling
string
IdentificationSupport
string
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 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
