Add information to a payment

Send us extra data elements such as application info, tender options, and additional data.

A basic Terminal API payment request includes the amount, currency, ID, and timestamp of the transaction. But maybe you want to add information that you want us to apply to your request, or save on the Adyen payments platform. The SaleToAcquirerData field allows you to do that. In this field you can add all kinds of data elements:

Application info that we can use for troubleshooting purposes.
Metadata of your own choice that you want to connect to the payment.
Data to use for shopper recognition and tokenization.
Dynamic shopper statements.
Split payment details.
Tender options to influence how the transaction is processed.
Additional data for common use cases like pre-authorisation, or hospitality.

Refer to the sample collection of SaleToAcquirerData to see what these data elements look like. Below we describe them in a bit more detail, and we explain how to add a combination of data elements to your payment request.

Application info

Application info consists of data elements that identify the software that you use for making payment requests to the Adyen payments platform. When you pass this information in your payment requests, we are able to analyze and troubleshoot payments more efficiently, and provide a better support experience.

For details, see Pass application info

Metadata

Metadata are data elements that you create yourself. When you add metadata to your payment request, they are echoed in the response so that you can connect the transaction to your metadata. For example, to add a shift number and an employee ID to a payment. You are free to create up to 20 metadata fields, where the maximum field name is 20 characters, and the maximum value 80 characters.

To also receive metadata in your settlement reports, contact our POS Support Team.

Shopper recognition and tokenization

Based on shopper identifiers that you receive in your payment response, you can link the payment to a shopper. This enables you to personalize the shopping experience or make recurring payments using a token instead of real card details. But first you need to create those shopper identifiers and store them on the Adyen payments platform. To do so, you include data elements like shopperEmail, shopperReference, and recurringContract in the SaleToAcquirerData field of your initial payment request.

For more information see Shopper recognition.

Shopper statement

To enable shoppers to easily identify your charges on their bank statement, you can provide a dynamic shopperStatement in your payment request. We recommend sending no more than 22 characters and using only a-z, A-Z, 0-9, spaces, and the special characters . , ' _ - ? + * /. That's because banks may cut off longer statements and do not always support Unicode characters.

Contact our POS Support Team to configure your account for providing shopper statements by API.

Split payments

Platforms usually split payments between the platform and the users of the platform. Using the SaleToAcquirerData field you can define how to split a payment, such as the amount and type of each split and the accounts that receive the splits.

For instructions, see our Aden for Platforms documentation about processing in-person payments.

Tender options

Tender options are parameters that change how the tender is processed. For example, the tender option AskGratuity triggers the payment terminal to ask the shopper for a tip.

Additional data

There are many additional data elements that you can add to your payment requests. The list 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.

Adding data elements to your request

There are two ways to pass data elements in the SaleToAcquirerData field of your payment request:

Option 1: as a JSON object converted to a Base64-encoded string.
Option 2: as form-encoded key-value pairs (using & as a separator).

Refer to the sample collection of SaleToAcquirerData to see what these formats look like.

The format of the SaleToAcquirerData, Base64-encoded or key-value pairs, determines the format of the AdditionalResponse that you receive. To always receive the AdditionalResponse in one of those formats, contact our POS Support Team.

Receiving the additional response

The AdditionalResponse in your payment response returns information resulting from the processing of your payment request. It also echoes some of the information you added to your payment request, so you can use this in your business logic.

The additional response can contain many data fields, but you may not need them all. To select the data that you want:

In your Customer Area, go to Developers > API URLs.
On the Additional data settings tab, select the options for the type of data you want to receive.

The format of the AdditionalResponse corresponds with the format of the SaleToAcquirerData in the payment request: a Base64-encoded JSON object, or form-encoded key-value pairs.
If the request doesn't contain any SaleToAcquirerData, the AdditionalResponse will be in key-value pairs format.

Option 1: Pass data elements as Base64-encoded JSON

This example shows how to add data elements to your payment request as a JSON object converted to a Base64-encoded string:

Create a JSON object with the data elements you want to pass.

In this example, we use a limited set of data:
- Metadata: the key employeeNumber with a value of 1
- Shopper statement: Book shop - ISBN 9780706414004
- Shopper email: S.Hopper@example.com
- Shopper reference: CUST01_34582
- Two tender options: ReceiptHandler to let the POS app handle printing or sending the receipt, and AskGratuity to ask for a tip.
So the JSON object looks like this:
Data elements in JSON format
{ "metadata": { "employeeNumber": "1" }, "shopperStatement": "Book shop - ISBN 9780706414004", "shopperEmail": "S.Hopper@example.com", "shopperReference": "CUST01_34582", "tenderOption": "ReceiptHandler,AskGratuity" }
https://docs.adyen.com/point-of-sale/add-data#data-elements-in-json-format

Encode the JSON object to Base64.

ewogICAibWV0YWRhdGEiOnsKICAgICAgImVtcGxveWVlTnVtYmVyIjoiMSIKICAgfSwKICAgInNob3BwZXJTdGF0ZW1lbnQiOiJCb29rIHNob3AgLSBJU0JOIDk3ODA3MDY0MTQwMDQiLAogICAic2hvcHBlckVtYWlsIjoiUy5Ib3BwZXJAZXhhbXBsZS5jb20iLAogICAic2hvcHBlclJlZmVyZW5jZSI6IkNVU1QwMV8zNDU4MiIsCiAgICJ0ZW5kZXJPcHRpb24iOiJSZWNlaXB0SGFuZGxlcixBc2tHcmF0dWl0eSIKfQ==

Make a payment request with:

SaleData.SaletoAcquirerData: the Base64-encoded JSON object.

{
    "SaleToPOIRequest": {
        "PaymentRequest": {
            "SaleData": {
                "SaleToAcquirerData": "ewogICAibWV0YWRhdGEiOnsKICAgICAgImVtcGxveWVlTnVtYmVyIjoiMSIKICAgfSwKICAgInNob3BwZXJTdGF0ZW1lbnQiOiJCb29rIHNob3AgLSBJU0JOIDk3ODA3MDY0MTQwMDQiLAogICAic2hvcHBlckVtYWlsIjoiUy5Ib3BwZXJAZXhhbXBsZS5jb20iLAogICAic2hvcHBlclJlZmVyZW5jZSI6IkNVU1QwMV8zNDU4MiIsCiAgICJ0ZW5kZXJPcHRpb24iOiJSZWNlaXB0SGFuZGxlcixBc2tHcmF0dWl0eSIKfQ==",
                "SaleTransactionID": {
                    "TransactionID": "27908",
                    "TimeStamp": "2020-04-08T12:08:52+00:00"
                }
            },
            "PaymentTransaction": {
                "AmountsReq": {
                    "Currency": "EUR",
                    "RequestedAmount": 10.99
                }
            }
        },
        "MessageHeader": {
            "ProtocolVersion": "3.0",
            "MessageClass": "Service",
            "MessageCategory": "Payment",
            "MessageType": "Request",
            "ServiceID": "692",
            "SaleID": "POSSystemID12346",
            "POIID": "e280-346403161"
        }
    }
}

String POIID = "YOUR_TERMINAL_ID";
String serviceID = "YOUR_UNIQUE_ATTEMPT_ID";
String saleID = "YOUR_CASH_REGISTER_ID";
String transactionID = "YOUR_UNIQUE_TRANSACTION_ID";

SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest();
MessageHeader messageHeader = new MessageHeader();
messageHeader.setPOIID(POIID);
messageHeader.setMessageClass( MessageClassType.SERVICE );
messageHeader.setMessageType( MessageType.REQUEST );
messageHeader.setProtocolVersion("3.0");
messageHeader.setServiceID(serviceID);
messageHeader.setSaleID(saleID);
messageHeader.setMessageCategory( MessageCategoryType.PAYMENT );
saleToPOIRequest.setMessageHeader(messageHeader);

PaymentRequest paymentRequest = new PaymentRequest();
PaymentTransaction paymentTransaction = new PaymentTransaction();
AmountsReq amountsReq = new AmountsReq();
amountsReq.setRequestedAmount( BigDecimal.valueOf(10.99) );
amountsReq.setCurrency("EUR");
paymentTransaction.setAmountsReq(amountsReq);

TransactionConditions transactionConditions = new TransactionConditions();
paymentTransaction.setTransactionConditions(transactionConditions);
paymentRequest.setPaymentTransaction(paymentTransaction);

SaleData saleData = new SaleData();
saleData.setSaleToAcquirerData("ewogICAibWV0YWRhdGEiOnsKICAgICAgImVtcGxveWVlTnVtYmVyIjoiMSIKICAgfSwKICAgInNob3BwZXJTdGF0ZW1lbnQiOiJCb29rIHNob3AgLSBJU0JOIDk3ODA3MDY0MTQwMDQiLAogICAic2hvcHBlckVtYWlsIjoiUy5Ib3BwZXJAZXhhbXBsZS5jb20iLAogICAic2hvcHBlclJlZmVyZW5jZSI6IkNVU1QwMV8zNDU4MiIsCiAgICJ0ZW5kZXJPcHRpb24iOiJSZWNlaXB0SGFuZGxlcixBc2tHcmF0dWl0eSIKfQ==");
saleData.setTokenRequestedType( TokenRequestedType.CUSTOMER );
TransactionIdentification saleTransactionID = new TransactionIdentification();
saleTransactionID.setTransactionID(transactionID);
saleTransactionID.setTimeStamp(DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar()));
saleData.setSaleTransactionID(saleTransactionID);
paymentRequest.setSaleData(saleData);
saleToPOIRequest.setPaymentRequest(paymentRequest);
terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest);

https://docs.adyen.com/point-of-sale/add-data#pass-add-data-base64

Note that the payment response has an AdditionalResponse in the same format as the SaleToAcquirerData field: a Base64-encoded string.

{
    "SaleToPOIResponse": {
        "PaymentResponse": {
            "POIData": {...},
            "SaleData": {
                "SaleTransactionID": {
                    "TimeStamp": "2020-04-08T12:08:52.000Z",
                    "TransactionID": "27908"
                }
            },
            "PaymentReceipt": [...],
            "PaymentResult": {
                "AmountsResp": {
                    "AuthorizedAmount": 12.08,
                    "Currency": "EUR",
                    "TipAmount": 1.09,    
                },    
                "OnlineFlag": true,
                "PaymentAcquirerData": {...},
                },
                "PaymentInstrumentData": {
                    "CardData": {...},
                    "PaymentInstrumentType": "Card"
                }
            },
            "Response": {
                "Result": "Success",
                "AdditionalResponse": "eyAiYWRkaXRpb25hbERhdGEiOiB7ICJBSUQiOiAiQTAwMDAwMDAwNDEwMTAwMSIsICJQYXltZW50QWNjb3VudFJlZmVyZW5jZSI6ICJjWHM1cFc1cVJwcmVKZEZHUXRjWTM2cENBcWpTMiIsICJhY3F1aXJlclJlc3BvbnNlQ29kZSI6ICJBUFBST1ZFRCIsICJhbGlhcyI6ICJNNDY5NTA5NTk0ODU5ODAyIiwgImFsaWFzVHlwZSI6ICJEZWZhdWx0IiwgImFwcGxpY2F0aW9uTGFiZWwiOiAiTUNFTkdCUkdCUCIsICJhcHBsaWNhdGlvblByZWZlcnJlZE5hbWUiOiAibWMgZW4gZ2JyIGdicCIsICJiYWNrZW5kR2lmdGNhcmRJbmRpY2F0b3IiOiAiZmFsc2UiLCAiYmF0dGVyeUxldmVsIjogIjYlIiwgImNhcmRCaW4iOiAiNTQxMzMzIiwgImNhcmRIb2xkZXJOYW1lIjogIiBcLyIsICJjYXJkSG9sZGVyVmVyaWZpY2F0aW9uTWV0aG9kUmVzdWx0cyI6ICIxRjAzMDIiLCAiY2FyZElzc3VlTnVtYmVyIjogIjMzIiwgImNhcmRJc3N1ZXJDb3VudHJ5SWQiOiAiODI2IiwgImNhcmRTY2hlbWUiOiAibWMiLCAiY2FyZFN1bW1hcnkiOiAiOTk5OSIsICJjYXJkVHlwZSI6ICJtYyIsICJleHBpcnlNb250aCI6ICIwMiIsICJleHBpcnlZZWFyIjogIjIwMjgiLCAiZnVuZGluZ1NvdXJjZSI6ICJDUkVESVQiLCAiZ2lmdGNhcmRJbmRpY2F0b3IiOiAiZmFsc2UiLCAiZ3JhdHVpdHlBbW91bnQiOiAiMTA5IiwgImlzbzg2MDFUeERhdGUiOiAiMjAyMy0wMS0yNFQxMTozNzo1Ni42NjlaIiwgImlzc3VlckNvdW50cnkiOiAiR0IiLCAibWVyY2hhbnRSZWZlcmVuY2UiOiAiMjc5MDgiLCAibWV0YWRhdGEuZW1wbG95ZWVOdW1iZXIiOiAiMSIsICJtaWQiOiAiNTAiLCAib2ZmbGluZSI6ICJmYWxzZSIsICJwYXltZW50TWV0aG9kIjogIm1jIiwgInBheW1lbnRNZXRob2RWYXJpYW50IjogIm1jIiwgInBvc0Ftb3VudENhc2hiYWNrVmFsdWUiOiAiMCIsICJwb3NBbW91bnRHcmF0dWl0eVZhbHVlIjogIjEwOSIsICJwb3NBdXRoQW1vdW50Q3VycmVuY3kiOiAiRVVSIiwgInBvc0F1dGhBbW91bnRWYWx1ZSI6ICIxMjA4IiwgInBvc0VudHJ5TW9kZSI6ICJDTEVTU19DSElQIiwgInBvc09yaWdpbmFsQW1vdW50VmFsdWUiOiAiMTA5OSIsICJwb3NhZGRpdGlvbmFsYW1vdW50cy5ncmF0dWl0eUFtb3VudCI6ICIxMDkiLCAicG9zYWRkaXRpb25hbGFtb3VudHMub3JpZ2luYWxBbW91bnRDdXJyZW5jeSI6ICJFVVIiLCAicG9zYWRkaXRpb25hbGFtb3VudHMub3JpZ2luYWxBbW91bnRWYWx1ZSI6ICIxMDk5IiwgInBzcFJlZmVyZW5jZSI6ICJYREtUTkxERzk3NVpHTjgyIiwgInJlY3VycmluZy5zaG9wcGVyUmVmZXJlbmNlIjogIkNVU1QwMV8zNDU4MiIsICJzaG9wcGVyRW1haWwiOiAiUy5Ib3BwZXJAZXhhbXBsZS5jb20iLCAic2hvcHBlclJlZmVyZW5jZSI6ICJDVVNUMDFfMzQ1ODIiLCAic2hvcHBlclN0YXRlbWVudCI6ICJCb29rIHNob3AgLSBJU0JOIDk3ODA3MDY0MTQwMDQiLCAic3RhcnRNb250aCI6ICIwMSIsICJzdGFydFllYXIiOiAiMjAxNyIsICJ0YyI6ICI3MUQ0OUMyMTM2MkI3NENDIiwgInRpZCI6ICI0NzA2OTgzMiIsICJ0cmFuc2FjdGlvblJlZmVyZW5jZU51bWJlciI6ICJYREtUTkxERzk3NVpHTjgyIiwgInRyYW5zYWN0aW9uVHlwZSI6ICJHT09EU19TRVJWSUNFUyIsICJ0eGRhdGUiOiAiMjQtMDEtMjAyMyIsICJ0eHRpbWUiOiAiMTI6Mzc6NTYiIH0sICJzdG9yZSI6ICJBM25TdG9yZU5MIiB9",
            }
        },
        "MessageHeader": {...}
    }
}

https://docs.adyen.com/point-of-sale/add-data#base64-encoded-additionalresponse

Decode the Base64 string in the AdditionalResponse field of the payment response. This contains:

The metadata, shopperEmail, shopperReference, and shopperStatement from the request.
Data resulting from the processing of the payment. The shopper gave a 10% tip (1.09 EUR).

{
   "additionalData":{
      "AID":"A000000004101001",
      "PaymentAccountReference":"cXs5pW5qRpreJdFGQtcY36pCAqjS2",
      "acquirerResponseCode":"APPROVED",
      "alias":"M469509594859802",
      "aliasType":"Default",
      "applicationLabel":"MCENGBRGBP",
      "applicationPreferredName":"mc en gbr gbp",
      "backendGiftcardIndicator":"false",
      "batteryLevel":"6%",
      "cardBin":"541333",
      "cardHolderName":" \/",
      "cardHolderVerificationMethodResults":"1F0302",
      "cardIssueNumber":"33",
      "cardIssuerCountryId":"826",
      "cardScheme":"mc",
      "cardSummary":"9999",
      "cardType":"mc",
      "expiryMonth":"02",
      "expiryYear":"2028",
      "fundingSource":"CREDIT",
      "giftcardIndicator":"false",
      "gratuityAmount":"109",
      "iso8601TxDate":"2023-01-24T11:37:56.669Z",
      "issuerCountry":"GB",
      "merchantReference":"27908",
      "metadata.employeeNumber":"1",
      "mid":"50",
      "offline":"false",
      "paymentMethod":"mc",
      "paymentMethodVariant":"mc",
      "posAmountCashbackValue":"0",
      "posAmountGratuityValue":"109",
      "posAuthAmountCurrency":"EUR",
      "posAuthAmountValue":"1208",
      "posEntryMode":"CLESS_CHIP",
      "posOriginalAmountValue":"1099",
      "posadditionalamounts.gratuityAmount":"109",
      "posadditionalamounts.originalAmountCurrency":"EUR",
      "posadditionalamounts.originalAmountValue":"1099",
      "pspReference":"XDKTNLDG975ZGN82",
      "recurring.shopperReference":"CUST01_34582",
      "shopperEmail":"S.Hopper@example.com",
      "shopperReference":"CUST01_34582",
      "shopperStatement":"Book shop - ISBN 9780706414004",
      "startMonth":"01",
      "startYear":"2017",
      "tc":"71D49C21362B74CC",
      "tid":"47069832",
      "transactionReferenceNumber":"XDKTNLDG975ZGN82",
      "transactionType":"GOODS_SERVICES",
      "txdate":"24-01-2023",
      "txtime":"12:37:56"
   },
   "store":"YOUR_STORE"
}

https://docs.adyen.com/point-of-sale/add-data#decoded-base64-additionalresponse

Option 2: Pass data elements as key-value pairs

This example shows how to add data elements to your payment request as form-encoded key-value pairs.

Create a string with the data elements you want to pass in key-value pairs, using & as a separator between the pairs.

In this example, we use a limited set of data:
- Metadata: metadata.employeeNumber=1
- Shopper statement: shopperStatement=Book shop - ISBN 9780706414004
- Shopper email: shopperEmail=S.Hopper@example.com
- Shopper reference: shopperReference=CUST01_34582
- Two tender options, to let the POS app handle printing or sending the receipt, and to ask for a tip: tenderOption=ReceiptHandler,AskGratuity
So the string looks like this:
```
metadata.employeeNumber=1&shopperStatement=Book shop - ISBN 9780706414004&shopperEmail=S.Hopper@example.com&shopperReference=CUST01_34582&tenderOption=ReceiptHandler,AskGratuity
```