Display a QR Code

Learn how to display a QR code for a buyer to scan on the Square Terminal.

Overview

As part of creating custom workflows with the Terminal API, you can create a screen workflow that allows a buyer to scan a QR code. You send a Terminal action request of the QR_CODE type and configure options for the QR code in qr_code_options.

In the request body for qr_code_options, you provide the title text, body text, and barcode content that display on the screen.

For more information about encoding information to barcode content, see the open-source reference for barcode image processing standards.

Link to section

Example use case for the QR code

You can build a screen workflow that prompts the buyer to scan the QR code and download the seller's application.

An animation of the QR code screen displayed on the Square Terminal.

Link to section

Make a QR code scan input request

Send a Terminal action POST request using the CreateTerminalAction endpoint and specify the QR_CODE action type. In the qr_code_options body, provide screen text for title and body.

The Terminal action response includes an action_id and a PENDING status.

{
   "action": {
     "id": "termapia:abcdefg1234567",
     "device_id": "R5WNWB5BKNG9R",
     "deadline_duration": "PT5M",
     "status": "PENDING",
     "created_at": "2022-03-09T09:01:19.622Z",
     "updated_at": "2022-03-09T09:03:06.830Z",
     "type": "QR_CODE",
     "app_id": "sq0ids-abcdefg123456789",
     "qr_code_options": {
         "title": "Download the app",
         "body": "Skip the line with order ahead. Scan the QR code to download the app.",
         "barcode_contents": 
               "BEGIN:VEVENT\nSUMMARY:dtestewtse\nDTSTART:20210316T230200Z\nDTEND:20210317T000200Z\nEND:VEVENT\n"
     }
  }
}

The Square Terminal displays the QR code screen for the buyer.

A Square Terminal showing a screen asking the buyer how they want to receive reminders from the seller.

The Terminal action is put in a COMPLETED state and the Square Terminal displays the idle screen.

Send a GET request to see the Terminal action that includes the decision.

The following response example shows the response with the status of COMPLETED for the QR code request:

{
  "action": {
    "id": "termapia:abcdefg1234567",
    "device_id": "R5WNWB5BKNG9R",
    "deadline_duration": "PT5M",
    "status": "COMPLETED",
    "created_at": "2022-03-09T09:01:19.622Z",
    "updated_at": "2022-03-09T09:03:06.830Z",
    "type": "QR_CODE",
    "app_id": "sq0ids-abcdefg123456789",
    "qr_code_options": {
         "title": "Download the app",
         "body": "Skip the line with order ahead. Scan the QR code to download the app.",
         "barcode_contents": 
               "BEGIN:VEVENT\nSUMMARY:dtestewtse\nDTSTART:20210316T230200Z\nDTEND:20210317T000200Z\nEND:VEVENT\n"
     }
  }
}

Docs

Display a QR Code

On this page

Overview

Example use case for the QR code

Make a QR code scan input request

On this page