Search

Are you looking for test card numbers?

Would you like to contact support?

Point-of-sale icon

Show a QR code on the terminal

Let your shoppers scan a QR code from the display of the payment terminal.

You can use the display of your payment terminal to show a QR code which the shopper can scan with their mobile device. The QR code can contain anything you like. For example, a URL to join your loyalty program or to download an app, a message with a link to a promotional offer, or an invitation to visit your webshop. You can also add a header and footer to explain what the QR code is for.

The terminal shows the QR code during the time you set in the request. If you don't set a time-out, the QR code continues to be shown until you send another request. For example, a payment request, or a request to show the standby screen.

The next examples show a QR code with header and footer on a portrait (narrow) terminal display and on a landscape (wide) display.

   

Make a display request for a QR code

  1. If the QR code needs to contain more than just a URL, convert the content to a URL-encoded string. You'll need to specify the URL-encoded string in the display request, in the OutputContent.OutputBarcode.BarcodeValue.

    For example, if the QR code should have this content:

    Visit www.adyen.com/pos-payments and:
- Learn about the features we support
- Choose from a range of terminals

    The resulting URL-encoded string will look like this:

    Visit%20www.adyen.com%2Fpos-payments%20and%3A%0A-%20Learn%20about%20the%20features%20we%20support%0A-%20Choose%20from%20a%20range%20of%20terminals

    If the QR code needs to contain only a URL, for example https://www.adyen.com/pos-payments, there is no need to URL-encode that. You'll specify the URL in the display request as a plain text string.

  2. Make a POST request to a Terminal API endpoint, specifying:

    • DisplayRequest.DisplayOutput : An array with array items representing the elements to show on the terminal display. This includes the QR code and optionally a header and/or footer.

      QR code:

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      MinimumDisplayTime The number of seconds that the QR code screen is shown.
      If you omit this parameter, the terminal shows the QR code screen until you send another request, for example, a request to show the standby screen.
      ResponseRequiredFlag If not specified, defaults to true. The response then informs you whether this element was successfully shown.
      OutputContent.OutputFormat BarCode
      OutputContent.OutputBarcode.BarcodeType QRCode
      OutputContent.OutputBarcode.BarcodeValue The content of the QR code, specified either as a plain text string, or as a URL encoded string. (See step 1.)

      The header and footer are both text array items with the same structure. If you specify one text array item, that will be interpreted as the header. If you specify a second text array item, that will be interpreted as the footer.

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      ResponseRequiredFlag If not specified, defaults to true. The response then informs you whether this element was successfully shown.
      OutputContent.OutputFormat Text
      OutputContent.OutputText An array with a Text parameter containing your text to show above the QR code (header element) or below the QR code (footer element).
    QR code with header and footer 
    {
   "SaleToPOIRequest":{
      "MessageHeader":{
         "ProtocolVersion":"3.0",
         "MessageClass":"Device",
         "MessageCategory":"Display",
         "MessageType":"Request",
         "ServiceID":"043001",
         "SaleID":"POSSystemID12345",
         "POIID":"V400m-346403161"
      },
      "DisplayRequest":{
         "DisplayOutput":[
            {
               "Device":"CustomerDisplay",
               "InfoQualify":"Display",
               "MinimumDisplayTime":60,
               "OutputContent":{
                  "OutputFormat":"BarCode",
                  "OutputBarcode":{
                     "BarcodeType":"QRCode",
                     "BarcodeValue":"www.adyen.com/pos-payments"
                  }
               }
            },
            {
               "Device":"CustomerDisplay",
               "InfoQualify":"Display",
               "OutputContent":{
                  "OutputFormat":"Text",
                  "OutputText":[
                     {
                        "Text":"Join our loyalty program"
                     }
                  ]
               }
            },
            {
               "Device":"CustomerDisplay",
               "InfoQualify":"Display",
               "OutputContent":{
                  "OutputFormat":"Text",
                  "OutputText":[
                     {
                        "Text":"Thank you!"
                     }
                  ]
               }
            }
         ]
      }
   }
}

    If you didn't set the ResponseRequiredFlag to false in all array items, you receive a display response with:

    • OutputResult: An array that indicates whether the elements were successfully shown. The first item in this array refers to the first item in the DisplayOutput array , and so on.
    Display response 
    {
    "SaleToPOIResponse": {
        "DisplayResponse": {
            "OutputResult": [
                {
                    "Device": "CustomerDisplay",
                    "InfoQualify": "Display",
                    "Response": {
                        "Result": "Success"
                    }
                },
                {
                    "Device": "CustomerDisplay",
                    "InfoQualify": "Display",
                    "Response": {
                        "Result": "Success"
                    }
                },
                {
                    "Device": "CustomerDisplay",
                    "InfoQualify": "Display",
                    "Response": {
                        "Result": "Success"
                    }
                }
            ]
        },
        "MessageHeader": {...}
    }
}

See also