Pesquisar

Are you looking for test card numbers?

Would you like to contact support?

Atenção, esta página não se encontra disponível em Português
Point-of-sale 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 can't mention all of them here. See for example the Additional data in our API Explorer. Many of these elements also apply to in-store payments.

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

{
    "applicationInfo": {
        "merchantApplication": {
            "name": "ADYEN_APPLICATION_NAME",
            "version": "2.0.1"
        },
        "externalPlatform": {
            "integrator": "INTEGRATOR_COMPANY_NAME",
            "name": "PLATFORM_NAME",
            "version": "2.0"
        },
        "merchantDevice": {
            "os": "CASH_REGISTER_OPERATING_SYSTEM",
            "osVersion": "10.12.6",
            "reference": "CASH_REGISTER_CONFIGURED_NAME"
        }
    },
    "metadata": {
        "someMetaDataKey1": "YOUR_VALUE",
        "someMetaDataKey2": "YOUR_VALUE"
    },
    "recurringContract": "ONECLICK,RECURRING",
    "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": "1525",
        "split.currencyCode": "USD",
        "split.item1.amount": "1425",
        "split.item1.type": "MarketPlace",
        "split.item1.account": "100038081",
        "split.item1.reference": "-P1",
        "split.item1.description": "Part 1 to Hub X",
        "split.item2.amount": "100",
        "split.item2.type": "MarketPlace",
        "split.item2.account": "198178867",
        "split.item2.reference": "-P2",
        "split.item2.description": "Part 2 to Spoke Y",
        "taxfree.indicator": false,
        "travelEntertainmentAuthData.market": "H",
        "travelEntertainmentAuthData.duration": "3"
    }
}

For instructions, see Option 2: Pass data elements as key-value pairs.

applicationInfo.merchantApplication.name=ADYEN_APPLICATION_NAME
applicationInfo.merchantApplication.version=2.0.1
applicationInfo.externalPlatform.integrator=INTEGRATOR_COMPANY_NAME
applicationInfo.externalPlatform.name=PLATFORM_NAME
applicationInfo.externalPlatform.version=2.0
applicationInfo.merchantDevice.os=CASH_REGISTER_OPERATING_SYSTEM
applicationInfo.merchantDevice.osVersion=10.12.6
applicationInfo.merchantDevice.reference=CASH_REGISTER_CONFIGURED_NAME
metadata.someMetaDataKey1=YOUR_VALUE
metadata.someMetaDataKey2=YOUR_VALUE
recurringContract=ONECLICK,RECURRING
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
additionalData.split.api=1
additionalData.split.nrOfItems=2
additionalData.split.totalAmount=1525
additionalData.split.currencyCode=USD
additionalData.split.item1.amount=1425
additionalData.split.item1.type=MarketPlace
additionalData.split.item1.account=100038081
additionalData.split.item1.reference=-P1
additionalData.split.item1.description=Part 1 to Hub X
additionalData.split.item2.amount=100
additionalData.split.item2.type=MarketPlace
additionalData.split.item2.account=198178867
additionalData.split.item2.reference=-P2
additionalData.split.item2.description=Part 2 to Spoke Y
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