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 can't 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.
JSON object
Key-value pairs
JSON object
Key-value pairs
For instructions, see Option 2: Pass data elements as key-value pairs .
applicationInfo.externalPlatform.name=COMPANY_NAME_OR_PLATFORM_NAME
applicationInfo.externalPlatform.version=1.3
applicationInfo.externalPlatform.integrator=COMPANY_THAT_BUILT_INTEGRATION_OR_POS_APP
applicationInfo.merchantApplication.name=NAME_OF_POS_APPLICATION
applicationInfo.merchantApplication.version=2.13.05
applicationInfo.merchantDevice.os=OS_OF_DEVICE_THAT_RUNS_POS_APPLICATION
applicationInfo.merchantDevice.osVersion=16.3
metadata.someMetaDataKey1=YOUR_VALUE
metadata.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
taxfree.indicator=false
tenderOption=ReceiptHandler,AskGratuity
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
additionalData.authorisationType=PreAuth
additionalData.lodging.customerServiceTollFreeNumber=1800433999
additionalData.lodging.checkInDate=20200219
additionalData.lodging.checkOutDate=20200222
additionalData.lodging.folioNumber=13579111315
additionalData.lodging.propertyPhoneNumber=1800433999
additionalData.lodging.room1.rate=15000
additionalData.lodging.room1.tax=1000
additionalData.lodging.room1.numberOfNights=3
additionalData.lodging.fireSafetyActIndicator=Y
additionalData.lodging.totalRoomTax=2000
additionalData.travelEntertainmentAuthData.market=H
additionalData.travelEntertainmentAuthData.duration=3
additionalData.manualCapture=false