--- title: "Display notifications" description: "Receive terminal-generated display notifications in your POS app." url: "https://docs.adyen.com/point-of-sale/design-your-integration/notifications/display-notifications" source_url: "https://docs.adyen.com/point-of-sale/design-your-integration/notifications/display-notifications.md" canonical: "https://docs.adyen.com/point-of-sale/design-your-integration/notifications/display-notifications" last_modified: "2026-05-24T12:54:31+02:00" language: "en" --- # Display notifications Receive terminal-generated display notifications in your POS app. [View source](/point-of-sale/design-your-integration/notifications/display-notifications.md) During a transaction or *[tender](/get-started-with-adyen/adyen-glossary/#tender)*, the payment terminal generates display notifications. You can show these in your POS app to keep your staff up-to-date on the progress of the tender. For example, whether the customer has selected Dynamic Currency Conversion, or finished entering their PIN. Here we describe how to set up display notifications. You can do this in your [Customer Area](#set-up-in-ca) or by using [API calls](#set-up-display-notifications-using-api-calls). You then receive webhooks that include a Terminal API `DisplayRequest` from the terminal. This has an `event` indicating the progress of the transaction, or the `result` of the transaction. You can use this information to show a message in your POS app. We also provide an overview of [display notification types](#display-notification-types), and [examples](#examples) of each. ## Set up display notifications in the Customer Area To get display notifications, you need to make sure you can receive HTTP callbacks (webhooks) on a specific endpoint. Then you need to provide the URL to that endpoint in your Customer Area. Make sure to [acknowledge](#accept-display-notifications) that your POS system successfully received a display notification from the terminal. 1. Prepare your system. It needs to have: * An endpoint that can receive JSON messages. * For the test environment: an open TCP port for HTTP traffic (80, 8080, or 8888) or HTTPS traffic (443, 8443, or 8843) with TLSv1.2. * For the live environment: an open TCP port for HTTPS traffic (443, 8443, or 8843) with TLSv1.2. 2. Log in to your [Customer Area](https://ca-test.adyen.com/). 3. Switch to the merchant account, store, or terminal that you want to set up notifications for. 4. Go to **In-person payments** > **Terminal settings** > **Integrations**. 5. In the **Terminal API** section, select **Decrypted**. 6. Under **Display URLs**, select **Add new**. 7. Select the pencil icon **next to the field that appears.\ The **Add URL** dialog opens. 8. Enter the details: * **URL**: the URL of the endpoint where you want to receive display notifications. * **Username** and **Password** (optional): the basic authentication credentials you set up on your server. We include these details in the header of the notification to authenticate with your server. * **Public**: select this option if the specified URL is on a public network. * **Local**: select this option if the specified URL is on a Local Area Network. * **Enable encryption**: select this if you want the message sent to this URL to be encrypted. 9. Select **Add URL**. 10. Select **Save**. Display notifications will now be sent to the endpoint you specified. ## Set up display notifications using API calls Instead of [using your Customer Area](#set-up-in-ca), you can use our [Management API](/point-of-sale/automating-terminal-management/configure-terminals-api) to automate setting up display notifications. To get display notifications, make sure you can receive HTTP callbacks (webhooks) on a specific endpoint. You then need to provide the URL to that endpoint in the PATCH request. Make sure to [acknowledge](#accept-display-notifications) that your POS system successfully received a display notification from the terminal. To set up display notifications, you need to have the following [role](/development-resources/api-credentials#api-permissions): * Management API - Terminal settings Advanced read and write Proceed as follows: 1. Prepare your system. It needs to have: * An endpoint that can receive JSON messages. * For the test environment: an open TCP port for HTTP traffic (80, 8080, or 8888) or HTTPS traffic (443, 8443, or 8843) with TLSv1.2. * For the live environment: an open TCP port for HTTPS traffic (443, 8443, or 8843) with TLSv1.2. 2. Optional. To see what display notification settings have already been configured, make a GET request to the `/terminalSettings` endpoint for the [company account](https://docs.adyen.com/api-explorer/Management/latest/get/companies/\(companyId\)/terminalSettings), [merchant account](https://docs.adyen.com/api-explorer/Management/latest/get/merchants/\(merchantId\)/terminalSettings), [store](https://docs.adyen.com/api-explorer/Management/latest/get/stores/\(storeId\)/terminalSettings) or [terminal](https://docs.adyen.com/api-explorer/Management/latest/get/terminals/\(terminalId\)/terminalSettings), and check the `nexo.displayUrls` object. When removing settings, you need to know the settings that will be [inherited](/point-of-sale/automating-terminal-management/configure-terminals-api#inheritance) from the next higher level. 3. Make a PATCH request to the `/terminalSettings` endpoint on the [company account](https://docs.adyen.com/api-explorer/Management/latest/get/companies/\(companyId\)/terminalSettings), [merchant account](https://docs.adyen.com/api-explorer/Management/latest/get/merchants/\(merchantId\)/terminalSettings), [store](https://docs.adyen.com/api-explorer/Management/latest/get/stores/\(storeId\)/terminalSettings) or [terminal](https://docs.adyen.com/api-explorer/Management/latest/get/terminals/\(terminalId\)/terminalSettings) level.\ In the request body, inside the [nexo](https://docs.adyen.com/api-explorer/Management/latest/patch/companies/\(companyId\)/terminalSettings#request-nexo) object, specify: * `localUrls`: an array with one or more local URLs. Use this if the specified URL is on a Local Area Network. This includes: | Parameter | Data type | Description | | ----------- | --------- | ------------------------------------------------------------------------------------------------------ | | `encrypted` | Boolean | Indicates if the message sent to this URL should be encrypted. | | `password` | String | The password for authentication of the notifications. | | `url` | String | The URL of the endpoint where they want to receive notifications, in the format: http(s)://domain.com. | | `username` | String | The username for authentication of the notifications. | * `publicUrls`: an array with one or more public URLs. Use this if the specified URL is on a public network. This includes: | Parameter | Data type | Description | | ----------- | --------- | ------------------------------------------------------------------------------------------------------ | | `encrypted` | Boolean | Indicates if the message sent to this URL should be encrypted. | | `password` | String | The password for authentication of the notifications. | | `url` | String | The URL of the endpoint where they want to receive notifications, in the format: http(s)://domain.com. | | `username` | String | The username for authentication of the notifications. | **Set up a local URL on a terminal level** ```json curl https://management-test.adyen.com/v3/terminals/{terminalId}/terminalSettings \ -H 'x-API-key: ADYEN_API_KEY' \ -X PATCH \ -d '{ "nexo": { "displayUrls":{ "localUrls":[ { "encrypted":"true", "password":"BASIC_AUTH_PASSWORD", "url":"https://your-display-notifications-endpoint.com", "username":"BASIC_AUTH_USERNAME" } ] } } }' ``` 4. When you receive the response, note that this returns the entire configuration at the level where you made the request. **Response with the entire configuration on a terminal level** ```json { "cardholderReceipt":{ "headerForAuthorizedReceipt":"header1,header2,filler" }, "gratuities":[ { "currency":"EUR", "usePredefinedTipEntries":true, "predefinedTipEntries":[ "100", "1%", "5%" ], "allowCustomAmount":true } ], "nexo":{ "displayUrls":{ "localUrls":[ { "password":"BASIC_AUTH_PASSWORD", "url":"https://your-display-notifications-endpoint.com", "username":"BASIC_AUTH_USERNAME" } ] }, "encryptionKey":{ "identifier":"KEY_IDENTIFIER", "passphrase":"KEY_PASSPHRASE", "version":1 }, "eventUrls":{ "eventPublicUrls":[ { "password":"BASIC_AUTH_PASSWORD", "url":"https://your-event-notifications-endpoint.com", "username":"BASIC_AUTH_USERNAME" } ] } }, "opi":{ "enablePayAtTable":true, "payAtTableStoreNumber":"1", "payAtTableURL":"https:/your-pay-at-table-endpoint.com" }, "offlineProcessing":{ "chipFloorLimit":0 }, "receiptOptions":{ "qrCodeData":"http://www.example.com/order/${pspreference}/${merchantreference}" }, "receiptPrinting":{ "shopperApproved":true, "shopperRefused":true, "shopperCancelled":true, "shopperRefundApproved":true, "shopperRefundRefused":true, "shopperVoid":true }, "signature":{ "askSignatureOnScreen":true, "skipSignature":false, "deviceName":"Amsterdam-236203386" }, "wifiProfiles":{ "profiles":[ { "authType":"wpa-psk", "autoWifi":false, "bssType":"infra", "channel":0, "defaultProfile":true, "hiddenSsid":false, "name":"Guest Wi-Fi", "psk":"4R8R2R3V456X", "ssid":"G470P37660D4G", "wsec":"ccmp" } ], "settings":{ "band":"All", "roaming":true } }, "timeouts":{ "fromActiveToSleep":30 }, "hardware":{ "displayMaximumBackLight":75 }, "connectivity":{ "simcardStatus":"INVENTORY" } } ``` ## Accept display notifications We require you to acknowledge that your POS system successfully received a display notification from the terminal with a [successful HTTP response status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#successful_responses), for example **202**. This prevents the terminal or our backend from repeatedly re-sending the same notification. When your POS system receives an display notification: 1. Store the display notification in your database. 2. Acknowledge the display notification with a [successful HTTP response status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#successful_responses), for example **202**. 3. Apply your business logic.\ Make sure that you acknowledge the display notification before you apply any business logic, because an error in your business logic can prevent event notifications with important updates from reaching your system. ## Display notification types A display notification is a `DisplayRequest` sent from the terminal. It includes a `ReferenceID` field with either: * `event`: the interaction between the terminal and the customer. * `Result`: the outcome of the transaction. Use the `ReferenceID` to show a message to your staff, informing them of the progress of the transaction. The main display notification types are: | Event | Description | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `TENDER_CREATED` | The tender has started.The `ReferenceID` includes: the `event` **TENDER\_CREATED**, and the `TimeStamp` and `TransactionID` of the transaction. | | `CARD_INSERTED` | The shopper has inserted their card into the terminal. | | `CARD_PRESENTED` | The shopper has presented the card to the terminal's contactless reader. | | `CARD_SWIPED` | The shopper has swiped their card. | | `WAIT_FOR APP_SELECTION` | The terminal is waiting for the shopper to select a payment application. | | `APPLICATION_SELECTED` | The shopper has selected their preferred payment application. | | `ASK_SIGNATURE` | The terminal has prompted the shopper to provide their signature. | | `CHECK_SIGNATURE` | The signature is ready to be checked by store staff. | | `SIGNATURE_CHECKED` | The signature has been checked by store staff. | | `WAIT_FOR_PIN` | The terminal is waiting for the shopper to enter their PIN. | | `PIN_ENTERED` | The shopper has finished entering their PIN. | | `PRINT_RECEIPT` | The terminal is printing the receipt. | | `RECEIPT_PRINTED` | The terminal has finished printing the receipt. | | `CARD_REMOVED` | The shopper has removed their card from the terminal. | | `TENDER_FINAL` | The tender was finished; the shopper either completed or abandoned the transaction.The `ReferenceID` includes: the `event` **TENDER\_FINAL**, and the `Result`, `TimeStamp`, and `TransactionID` of the transaction. | | `ASK_DCC` | The terminal is asking if the shopper requires dynamic currency conversion. | | `DCC_ACCEPTED` | The shopper accepted the dynamic currency conversion request. | | `DCC_REJECTED` | The shopper rejected the dynamic currency conversion request. | | `ASK_GRATUITY` | The terminal is waiting for a possible tip. | | `GRATUITY_ENTERED` | The shopper has entered a gratuity on the terminal. | | `BALANCE_QUERY_STARTED` | Balance check started on the terminal. | | `BALANCE_QUERY_COMPLETED` | Balance check completed on the terminal. | | `LOAD_STARTED` | Gift card load has been initiated. | | `LOAD_COMPLETED` | Gift card load has been completed. | | `PROVIDE_CARD_DETAILS` | The terminal is waiting for card details to be entered manually. | | `CARD_DETAILS_PROVIDED` | The card details have been entered. | Examples of display notifications are provided below. ## Examples ### TENDER\_CREATED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device": "CashierDisplay", "InfoQualify": "Status", "OutputContent": { "OutputFormat": "MessageRef", "PredefinedContent": { "ReferenceID": "TransactionID=oLkO001517998574000&TimeStamp=2018-02-07T10%3a16%3a14.000Z&event=TENDER_CREATED" } }, "ResponseRequiredFlag": false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998562" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("TransactionID=oLkO001517998574000&TimeStamp=2018-02-07T10%3a16%3a14.000Z&event=TENDER_CREATED"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998562"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### CARD\_INSERTED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=CARD_INSERTED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998563" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=CARD_INSERTED"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998563"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### CARD\_SWIPED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=CARD_SWIPED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=CARD_SWIPED"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### WAIT\_FOR\_APP\_SELECTION #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=WAIT_FOR_APP_SELECTION" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998564" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=WAIT_FOR_APP_SELECTION"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998564"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### APPLICATION\_SELECTED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=APPLICATION_SELECTED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998565" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=APPLICATION_SELECTED"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998565"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### WAIT\_FOR\_PIN #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=WAIT_FOR_PIN" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998566" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=WAIT_FOR_PIN"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998566"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### PIN\_ENTERED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=PIN_ENTERED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998571" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=PIN_ENTERED"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998571"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### PRINT\_RECEIPT #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=PRINT_RECEIPT" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998572" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=PRINT_RECEIPT"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998572"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### CARD\_REMOVED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=CARD_REMOVED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); OutputContent outputContent = new OutputContent(); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=CARD_REMOVED"); outputContent.setPredefinedContent(predefinedContent); displayOutput.setOutputContent(outputContent); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### TENDER\_FINAL #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"Result=Success&TimeStamp=2018-09-27T14:40:18.000Z&TransactionID=faQm001538059218000.NC6HT9CRT65ZGN82&event=TENDER_FINAL" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("Result=Success&TimeStamp=2018-09-27T14:40:18.000Z&TransactionID=faQm001538059218000.NC6HT9CRT65ZGN82&event=TENDER_FINAL"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### BALANCE\_QUERY\_STARTED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=BALANCE_QUERY_STARTED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"Ray", "MessageClass":"Device", "MessageCategory":"Display", "ServiceID":"S34", "POIID":"V400m-324688179", "MessageType":"Request", "DeviceID":"39288033" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; String POIID = "YOUR_TERMINAL_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=BALANCE_QUERY_STARTED"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setServiceID(serviceID); messageHeader.setPOIID(POIID); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setDeviceID("39288033"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### GRATUITY\_ENTERED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=GRATUITY_ENTERED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=GRATUITY_ENTERED"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### LOAD\_STARTED #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=LOAD_STARTED" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=LOAD_STARTED"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ### PROVIDE\_CARD\_DETAILS #### JSON ```json { "SaleToPOIRequest":{ "DisplayRequest":{ "DisplayOutput":[ { "Device":"CashierDisplay", "InfoQualify":"Status", "OutputContent":{ "OutputFormat":"MessageRef", "PredefinedContent":{ "ReferenceID":"event=PROVIDE_CARD_DETAILS" } }, "ResponseRequiredFlag":false } ] }, "MessageHeader":{ "SaleID":"POSSystemID12345", "ProtocolVersion":"3.0", "MessageType":"Request", "POIID":"V400m-324688179", "ServiceID":"0207111617", "MessageClass":"Device", "MessageCategory":"Display", "DeviceID":"1517998573" } } } ``` #### Java ```java String saleID = "YOUR_CASH_REGISTER_ID"; String POIID = "YOUR_TERMINAL_ID"; String serviceID = "YOUR_UNIQUE_ATTEMPT_ID"; SaleToPOIRequest saleToPOIRequest = new SaleToPOIRequest(); DisplayRequest displayRequest = new DisplayRequest(); DisplayOutput displayOutput = new DisplayOutput(); displayOutput.setResponseRequiredFlag( Boolean.FALSE ); displayOutput.setDevice( DeviceType.CASHIER_DISPLAY ); displayOutput.setInfoQualify( InfoQualifyType.STATUS ); OutputContent outputContent = new OutputContent(); PredefinedContent predefinedContent = new PredefinedContent(); predefinedContent.setReferenceID("event=PROVIDE_CARD_DETAILS"); outputContent.setPredefinedContent(predefinedContent); outputContent.setOutputFormat( OutputFormatType.MESSAGE_REF ); displayOutput.setOutputContent(outputContent); displayRequest.setDisplayOutput(displayOutput); saleToPOIRequest.setDisplayRequest(displayRequest); MessageHeader messageHeader = new MessageHeader(); messageHeader.setSaleID(saleID); messageHeader.setProtocolVersion("3.0"); messageHeader.setMessageType( MessageType.REQUEST ); messageHeader.setPOIID(POIID); messageHeader.setServiceID(serviceID); messageHeader.setMessageClass( MessageClassType.DEVICE ); messageHeader.setMessageCategory( MessageCategoryType.DISPLAY ); messageHeader.setDeviceID("1517998573"); saleToPOIRequest.setMessageHeader(messageHeader); terminalAPIRequest.setSaleToPOIRequest(saleToPOIRequest); ``` ## Next steps [required](/point-of-sale/design-your-integration/terminal-api) [Terminal API](/point-of-sale/design-your-integration/terminal-api) [Learn about our Terminal API.](/point-of-sale/design-your-integration/terminal-api) [Event notifications](/point-of-sale/design-your-integration/notifications/event-notifications) [Receive asynchronous responses and notifications of terminal events.](/point-of-sale/design-your-integration/notifications/event-notifications) [Platform-generated webhooks](/point-of-sale/design-your-integration/notifications/standard-notifications) [Receive standard webhooks generated by our platform.](/point-of-sale/design-your-integration/notifications/standard-notifications)