Terminal-2 icon

SaleToAcquirerData

The examples on this page illustrate the structure of many of the data elements that you can pass in the SaleToAcquirerData field of your Terminal API payment request.

Be aware that the list of additionalData elements is long and growing, so we cannot mention all of them here. See for example the Additional data in our API Explorer. Many of these elements also apply to point-of-sale payments.

For instructions, see Option 1: Pass data elements as Base-64 encoded JSON.

Expand view
Copy link to code block
Copy code
Copy code
{
"applicationInfo": {
"externalPlatform": {
"name": "COMPANY_NAME_OR_PLATFORM_NAME",
"version": "1.3",
"integrator": "COMPANY_THAT_BUILT_INTEGRATION_OR_POS_APP"
},
"merchantApplication": {
"name": "NAME_OF_POS_APPLICATION",
"version": "2.13.05"
},
"merchantDevice": {
"os": "OS_OF_DEVICE_THAT_RUNS_POS_APPLICATION",
"osVersion": "16.3"
}
},
"metadata": {
"someMetaDataKey1": "YOUR_VALUE",
"someMetaDataKey2": "YOUR_VALUE"
},
"recurringProcessingModel": "Subscription",
"recurringDetailName": "YOUR_VALUE",
"recurringTokenService": "YOUR_VALUE",
"shopperEmail": "S.Hopper@example.com",
"shopperReference": "YOUR_UNIQUE_SHOPPER_ID",
"shopperStatement": "YOUR_PAYMENT_DESCRIPTION",
"store": "STORE_ID",
"tenderOption": "ReceiptHandler,AskGratuity",
"additionalData": {
"authorisationType": "PreAuth",
"lodging.customerServiceTollFreeNumber": "1800433999",
"lodging.checkInDate": "20200219",
"lodging.checkOutDate": "20200222",
"lodging.folioNumber": "13579111315",
"lodging.propertyPhoneNumber": "1800433999",
"lodging.room1.rate": "15000",
"lodging.room1.tax": "1000",
"lodging.room1.numberOfNights": "3",
"lodging.fireSafetyActIndicator": "Y",
"lodging.totalRoomTax": "2000",
"split.api": "1",
"split.nrOfItems": "2",
"split.totalAmount": "62000",
"split.currencyCode": "EUR",
"split.item1.amount": "60000",
"split.item1.type": "BalanceAccount",
"split.item1.account": "BA00000000000000000000001",
"split.item1.reference": "TestPayment",
"split.item1.description": "TestDescription",
"split.item2.amount": "2000",
"split.item2.type": "Commission",
"split.item2.reference": "TestCommission",
"taxfree.indicator": false,
"travelEntertainmentAuthData.market": "H",
"travelEntertainmentAuthData.duration": "3",
"manualCapture": "false"
}
}