Point-of-sale icon

Exibir uma imagem no terminal

Engage seus clientes exibindo um anúncio ou outra imagem na tela do terminal de pagamento.

Você pode mostrar uma imagem no visor do seu terminal, por exemplo, um anúncio, ou uma oferta especial gerada pela caixa registradora. Ao mostrar uma imagem, você pode usar seu terminal para aumentar a fidelidade dos clientes ou para fins de marketing.

A imagem pode ser um arquivo PNG, JPEG, GIF ou BMP que você converte para Base64.

Uma solicitação para mostrar uma imagem não atinge o tempo limite. Depois de enviar a solicitação, a imagem permanecerá visível na tela até que você envie outra solicitação. Por exemplo, para parar de mostrar a imagem, você pode enviar uma solicitação para deixar o monitor inativo.


Segurança

O terminal nunca executa ou armazena uma imagem que recebe. O terminal apenas decodifica a imagem, para poder mostrá-la no display.

Faça uma solicitação de exibição de uma imagem

  1. Converta um arquivo de imagem PNG, JPEG, GIF ou BMP para Base64.

  2. Faça uma solicitação POST para um endpoint da API de Terminais, especificando:

    • MessageHeader: the standard SaleToPOIRequest.MessageHeader object. Specify:

      Parameter Required Description
      ProtocolVersion -white_check_mark- 3.0
      MessageClass -white_check_mark- Device
      MessageCategory -white_check_mark- Display
      MessageType -white_check_mark- Request
      ServiceID -white_check_mark- Your unique ID for this request, consisting of 1-10 alphanumeric characters. Must be unique within the last 48 hours for the terminal (POIID) being used.
      SaleID -white_check_mark- Your unique ID for the POS system component to send this request from.
      POIID -white_check_mark- The unique ID of the terminal to send this request to. Format: [device model]-[serial number].
    • DisplayRequest.DisplayOutput : Uma matriz com um item contendo:

      Parameter Description
      Device CustomerDisplay
      InfoQualify Display
      OutputContent.OutputFormat MessageRef
      OutputContent.PredefinedContent.ReferenceID Image
      OutputContent.OutputText Uma matriz com um Text parâmetro que contém a imagem como uma string codificada em Base64.
    {
       "SaleToPOIRequest":{
          "MessageHeader":{
             "ProtocolVersion":"3.0",
             "MessageClass":"Device",
             "MessageCategory":"Display",
             "MessageType":"Request",
             "ServiceID":"043001",
             "SaleID":"POSSystemID12345",
             "POIID":"V400m-346403161"
          },
          "DisplayRequest":{
             "DisplayOutput":[
                {
                   "Device":"CustomerDisplay",
                   "InfoQualify":"Display",
                   "OutputContent":{
                      "OutputFormat":"MessageRef",
                      "PredefinedContent":{
                         "ReferenceID":"Image"
                      },
                      "OutputText":[
                         {
                            "Text":"iVBORw0KGgoAAAAN...AAASUVORK5CYII="
                         }
                      ]
                   }
                }
             ]
          }
       }
    }

    Se ocorrer um erro ao decodificar a imagem, a imagem não será exibida.
    Se a solicitação for bem-sucedida, você receberá uma resposta de exibição com:

    • OutputResult.Response.Result: Success
    {
        "SaleToPOIResponse": {
            "DisplayResponse": {
                "OutputResult": [
                    {
                        "Device": "CustomerDisplay",
                        "InfoQualify": "Display",
                        "Response": {
                            "Result": "Success"
                        }
                    }
                ]
            },
            "MessageHeader": {...}
        }
    }

    A imagem continua a ser exibida no visor até que você envie outra solicitação.

Veja também