POST /cardacquisition

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 loyalty) which refers to this Card Acquisition message pair. Content of the Card Acquisition Request message.

Servers

https://terminal-api-test.adyen.com/sync
https://terminal-api-test.adyen.com/async
<local-terminal-IP-address>

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`CardAcquisitionTransaction`	Object	Yes	Data related to the payment and loyalty card acquisition.
`CardAcquisitionTransaction.LoyaltyHandling`	String	No	Type of Loyalty processing requested by the Sale System. An way to specify what the POI has to handle concerning the loyalty. Possible values: Allowed Forbidden Processed Proposed Required Possible values: `"Proposed"` `"Required"` `"Forbidden"` `"Processed"` `"Allowed"`
`CardAcquisitionTransaction.CashBackFlag`	Boolean	No	Cash back has been requested with the payment transaction. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface.
`CardAcquisitionTransaction.TotalAmount`	Number	No	Amount of a transaction. In the Card Acquisition Request message, it allows the processing of a contactless card.
`CardAcquisitionTransaction.ForceEntryMode[]`	Array	No	Payment instrument entry mode requested by the Sale System. Avoid retry on an out of order card reading device, when the sale system knows that some card entry modes on the POI do not work. Possible values: CheckReader Contactless File ICC Keyed MagStripe Manual RFID Scanned SynchronousICC Tapped
`CardAcquisitionTransaction.AllowedPaymentBrand[]`	Array	No	Card payment brands allowed by the Sale System for the payment transaction.
`CardAcquisitionTransaction.PaymentType`	String	No	Type of payment transaction. Elements requested by the Sale System that are related to the payment only. Possible values: CashAdvance CashDeposit Completion FirstReservation Instalment IssuerInstalment Normal OneTimeReservation PaidOut Recurring Refund UpdateReservation Possible values: `"CashDeposit"` `"Completion"` `"Recurring"` `"PaidOut"` `"OneTimeReservation"` `"Normal"` `"Instalment"` `"CashAdvance"` `"Refund"` `"IssuerInstalment"` `"UpdateReservation"` `"FirstReservation"`
`CardAcquisitionTransaction.AllowedLoyaltyBrand[]`	Array	No	Loyalty brands or programs allowed by the Sale System for the loyalty transaction.
`CardAcquisitionTransaction.ForceCustomerSelectionFlag`	Boolean	No	Indicates if the Customer realises the selection of the card application.
`SaleData`	Object	Yes	Data related to the Sale System.
`SaleData.OperatorID`	String	No	Identification of the Cashier or Operator.
`SaleData.SaleToAcquirerData`	String	No	Sale information intended for the Acquirer. Send to the Acquirer if present.
`SaleData.ShiftNumber`	String	No	Shift number. If different from the Login, see Login SaleData.
`SaleData.SaleTransactionID`	Object	Yes	Identification of a Sale transaction.
`SaleData.SaleTransactionID.TimeStamp`	String	Yes	Date and time of a transaction for the Sale System, the POI System or the Acquirer. Ensures the uniqueness of a transaction and indicates the time when the event occurs in the EventNotification message.
`SaleData.SaleTransactionID.TransactionID`	String	Yes	Unique identification of a transaction to identify the transaction on the Sale System (e.g. ticket number), or the POI System.
`SaleData.SaleReferenceID`	String	No	Identification of a Sale global transaction for a sequence of related POI transactions. If payment reservation.
`SaleData.CustomerOrderReq[]`	Array	No	List of customer order open, closed or both to be sent in the response messages. Possible values: Both Closed Open
`SaleData.SaleToPOIData`	String	No	Sale information intended for the POI. Stored with the transaction.
`SaleData.OperatorLanguage`	String	No	Language of the Cashier or Operator. If different from the Login.
`SaleData.SaleTerminalData`	Object	No	Information related to the software and hardware features of the Sale Terminal. If content is not empty.
`SaleData.SaleTerminalData.TotalsGroupID`	String	No	Identification of a group of transactions on a POI Terminal, having the same Sale features. Could be used to group POI for reconciliation or other purpose defined by the Sale System. The default value is assigned by the Login Request.
`SaleData.TokenRequestedType`	String	No	Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period. Possible values: Customer Transaction Possible values: `"Customer"` `"Transaction"`
`SaleData.CustomerOrderID`	String	No	Additional and optional identification of a customer order.
`SaleData.SaleToIssuerData`	Object	No	Sale information intended for the Issuer. Send to the Acquirer if present.
`SaleData.SaleToIssuerData.StatementReference`	String	No	Label to print on the bank statement.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.