Search docs

Are you looking for test card numbers?

Would you like to contact support?

Start searching Adyen's documentation...

  Documentation

Pass application information

Outlines using the terminal API to  provide application, merchant, and integrator details in additional data to the Adyen Payments Platform.

Application information, i.e. identifying information for the application, your company and any third party information, allows us to analyze and troubleshoot payments more efficiently, and provide a better support experience. In the Terminal API, this is passed in a SaleToAcquirerData field.

Endpoint

The URL used to send Terminal API messages depends on your type of implementation. For more information on the architectures available, see the Terminal API Overview.

Base64 the application information

  1. Add your application, merchant, and integrator details in JSON format:

    {
       "applicationInfo":{
          "merchantApplication":{
             "name":"Acme Adyen Connector",
             "version":"2.0.1"
          },
          "merchantDevice":{
             "os":"Windows",
             "version":"Vista Business 3.1",
             "reference":"1234"
          },
          "externalPlatform":{
             "integrator":"Retail Consultancy Corp",
             "name":"Acme Corp POS",
             "version":"1.0.2"
          }
       }
    }

    In the example above, the merchantDevice reference is the posRegisterConfiguredName, i.e. the name configured for the POS hardware.

  2. Convert this JSON to Base64 which will provide you with a string like:

    eyJhcHBsaWNhdGlvbkluZm8iOnsKICAibWVyY2hhbnRBcHBsaWNhdGlvbiI6ewog
    ICAgIm5hbWUiIDogIkFjbWUgQWR5ZW4gQ29ubmVjdG9yIiwKICAgICJ2ZXJzaW9u
    IiA6ICIyLjAuMSIKICAgIH0sCiAgIm1lcmNoYW50RGV2aWNlIjp7CiAgICAib3Mi
    IDogIldpbmRvd3MiLAogICAgInZlcnNpb24iIDogIlZpc3RhIEJ1c2luZXNzIDMu
    MSIsCiAgICAicmVmZXJlbmNlIiA6ICIxMjM0IiDigJMgcG9zcmVnaXN0ZXJjb25m
    aWd1cmVkbmFtZQogICAgfSwKICAgICJleHRlcm5hbFBsYXRmb3JtIjp7CiAgICAg
    ICJpbnRlZ3JhdG9yIiA6ICJSZXRhaWwgQ29uc3VsdGFuY3kgQ29ycCIsCiAgICAg
    ICJuYW1lIiA6ICJBY21lIENvcnAgUE9TIiwKICAgICAgInZlcnNpb24iIDogIjEu
    MC4yIgogICAgfQogIH0KfQ==
  3. Create a PaymentRequest and pass the string as additional data in the SaleToAcquirerData field.

Request

For a list of PaymentRequest fields, see PaymentRequest fields.

{
   "SaleToPOIRequest":{
      "MessageHeader":{
         "POIID":"MX925-286240330",
         "MessageClass":"Service",
         "MessageType":"Request",
         "ProtocolVersion":"3.0",
         "ServiceID":"1113162452",
         "SaleID":"POSSystemID12345",
         "MessageCategory":"Payment"
      },
      "PaymentRequest":{
         "PaymentTransaction":{
            "AmountsReq":{
               "RequestedAmount":10.99,
               "Currency":"EUR"
            },
            "TransactionConditions":{

            }
         },
         "SaleData":{
            "SaleToAcquirerData":"eyJhcHBsaWNhdGlvbkluZm8iOnsKICAibWVyY2hhbnRBcHBsaWNhdGlvbiI6ewog
ICAgIm5hbWUiIDogIkFjbWUgQWR5ZW4gQ29ubmVjdG9yIiwKICAgICJ2ZXJzaW9u
IiA6ICIyLjAuMSIKICAgIH0sCiAgIm1lcmNoYW50RGV2aWNlIjp7CiAgICAib3Mi
IDogIldpbmRvd3MiLAogICAgInZlcnNpb24iIDogIlZpc3RhIEJ1c2luZXNzIDMu
MSIsCiAgICAicmVmZXJlbmNlIiA6ICIxMjM0IiDigJMgcG9zcmVnaXN0ZXJjb25m
aWd1cmVkbmFtZQogICAgfSwKICAgICJleHRlcm5hbFBsYXRmb3JtIjp7CiAgICAg
ICJpbnRlZ3JhdG9yIiA6ICJSZXRhaWwgQ29uc3VsdGFuY3kgQ29ycCIsCiAgICAg
ICJuYW1lIiA6ICJBY21lIENvcnAgUE9TIiwKICAgICAgInZlcnNpb24iIDogIjEu
MC4yIgogICAgfQogIH0KfQ==",
            "TokenRequestedType":"Customer",
            "SaleTransactionID":{
               "TransactionID":"8377",
               "TimeStamp":"2017-11-13T15:24:52+00:00"
            }
         }
      }
   }
}

Response

For a list of PaymentResponse fields, see PaymentResponse fields.

An authorisation is attempted and you receive a response with the following fields, including an AdditionalResponse.

The AdditionalResponse is also Base64 encoded.

{  
   "SaleToPOIResponse":{  
      "PaymentResponse":{  
         "Response":{  
            "AdditionalResponse":"YXBwbGljYXRpb25MYWJlbD1NQ0RDQ0ZSJmNhcmRIb2xkZXJWZXJpZmljYXRpb25N
ZXRob2RSZXN1bHRzPTQ0MDAwMiZBSUQ9QTAwMDAwMDAwNDEwMTAwMiZhcHBsaWNh
dGlvblByZWZlcnJlZE5hbWU9bWMlMjBmJnRpZD0xMjAwMDAwMCZtZXJjaGFudFJl
ZmVyZW5jZT1DYXJkUmVtb3ZhbC1Bc2tEY2MmdGM9RjJCQ0FCRDYxNDc4QzExNyZ0
eGRhdGU9MTAtMTEtMjAxNyZwYXltZW50TWV0aG9kPW1jJnRyYW5zYWN0aW9uUmVm
ZXJlbmNlTnVtYmVyPTg1MTUxMDMxNTU5OTAzMDYmc2hvcHBlclJlZmVyZW5jZT0x
MjMxJnRyYW5zYWN0aW9uVHlwZT1HT09EU19TRVJWSUNFUyZjYXJkVHlwZT1tYyZv
ZmZsaW5lPWZhbHNlJmNhcmRTY2hlbWU9bWMmbWlkPTUxJnR4dGltZT0xMyUzYTA2
JTNhMTYmc2hvcHBlckVtYWlsPXN3YWclNDBpbGwuY29tJmNhcmRIb2xkZXJOYW1l
PVRDMDRfTUNfQXBwcm92ZWRfREND",
            "Result":"Success"
         },
         "PaymentResult":{  
            "PaymentAcquirerData":{  
               "AcquirerTransactionID":{  
                  "TransactionID":"8515103155990306",
                  "TimeStamp":"2017-11-10T12:06:16.000Z"
               },
               "MerchantID":"TestMerchantPOSRobot02",
               "AcquirerPOIID":"MX925-261078152"
            },
            "PaymentInstrumentData":{  
               "CardData":{  
                  "CardCountryCode":"840",
                  "EntryMode":[  
                     "ICC"
                  ],
                  "MaskedPan":"541333 **** 9990",
                  "PaymentBrand":"mc",
                  "SensitiveCardData":{  
                     "CardSeqNumb":"53",
                     "ExpiryDate":"0228"
                  }
               },
               "PaymentInstrumentType":"Card"
            },
            "AmountsResp":{  
               "AuthorizedAmount":300,
               "Currency":"EUR"
            }
         },
         "PaymentReceipt":[
            {
               "OutputContent":{
                  "OutputFormat":"Text",
                  "OutputText":[
                     {
                        "CharacterStyle":"Bold",
                        "EndOfLineFlag":true,
                        "Text":"key=header1&name=Adyen"
                     },
                      [...]
                     {
                        "EndOfLineFlag":true,
                        "Text":"key=filler"
                     },
                     {
                        "EndOfLineFlag":true,
                        "Text":"key=filler"
                     }
                  ]
               },
               "DocumentQualifier":"CashierReceipt"
            },
            {
               "OutputContent":{
                  "OutputFormat":"Text",
                  "OutputText":[
                     {
                        "CharacterStyle":"Bold",
                        "EndOfLineFlag":true,
                        "Text":"key=header1&name=Adyen"
                     },
                     [...]
                     {
                        "EndOfLineFlag":true,
                        "Text":"key=filler"
                     },
                     {
                        "EndOfLineFlag":true,
                        "Text":"key=thanks&name=Thank%20you"
                     }
                  ]
               },
               "DocumentQualifier":"CustomerReceipt"
            }
         ],
         "POIData":{  
            "POITransactionID":{  
               "TransactionID":"oLkO001510315576349.8515103155990306",
               "TimeStamp":"2017-11-10T12:06:16.000Z"
            }
         },
         "SaleData":{  
            "SaleTransactionID":{  
               "TransactionID":"CardRemoval-AskDcc",
               "TimeStamp":"2017-11-10T12:05:58.686Z"
            }
         }
      },
      "MessageHeader":{  
         "SaleID":"POSSystemID12345",
         "ProtocolVersion":"3.0",
         "MessageType":"Response",
         "POIID":"MX925-261078152",
         "ServiceID":"885906155",
         "MessageClass":"Service",
         "MessageCategory":"Payment"
      }
   }
}

If you receive an error, use our Error Scenarios page to troubleshoot the issue.

Warnings are triggered when non-fatal errors occur and are returned in the response.