# PROC003 - Fluxo PIX Shipay (falta finalizar)

<table border="1" id="bkmrk-%C2%A0-projeto%2Fsistema%3Age" style="border-collapse: collapse; width: 100.123%; height: 68px;"><tbody><tr style="border-style: solid;"><td rowspan="3" style="width: 26.6667%; height: 68px; border-color: black; border-top-style: hidden; border-left-style: hidden; border-bottom-style: hidden;">  
[![image-1762776253666.png](https://docs.softensistemas.com.br/uploads/images/gallery/2025-11/scaled-1680-/image-1762776253666.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2025-11/image-1762776253666.png)

</td><td style="width: 49.9999%; height: 10px; border-color: black; border-style: solid;"><span style="color: #000000;">**Projeto/Sistema:**</span>  
Shipay - GerencieVendas</td><td class="align-center" style="width: 23.3333%; height: 10px; border-color: black; border-style: solid;"><span style="color: #000000;">**Versão do *Template:***</span>  
<span style="color: #000000;">1.2</span></td></tr><tr style="border-style: solid;"><td style="width: 49.9999%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Processo:**</span>  
<span style="color: #000000;">PROC003 - Fluxo PIX Shipay</span></td><td class="align-center" style="width: 23.3333%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Versão do Documento:**</span>  
<span style="color: #000000;">1.0</span></td></tr><tr style="border-style: solid;"><td style="width: 49.9999%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Responsável(eis):** </span>  
<span style="color: #000000;">Luís Leite</span></td><td class="align-center" style="width: 23.3333%; height: 29px; border-color: black; border-style: solid;"><span style="color: #000000;">**Data:** </span>

<span style="color: #000000;">05/01/2026</span>

</td></tr></tbody></table>

#####  

##### <span style="color: #000000;">**1. Introdução**</span>

<span style="color: #000000;">**Esta documentação visa registrar o processo para a utilização do PIX via Shipay no aplicativo GerencieVendas**</span>

<table cellpadding="9" cellspacing="0" id="bkmrk-processo-envolvidos-" style="width: 100%;" width="100%"><tbody><tr valign="top"><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 27%;" width="27%"><span style="font-size: small; color: #000000;">**Processo**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 19%;" width="19%"><span style="font-size: small; color: #000000;">**Envolvidos**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 27%;" width="27%"><span style="font-size: small; color: #000000;">**Dados de Entrada**</span>

</td><td bgcolor="#acb9ca" style="border-style: solid; border-color: black; width: 27%;" width="27%"><span style="font-size: small; color: #000000;">**Dados de Saída**</span>

</td></tr><tr valign="top"><td style="border-style: solid; border-color: black; width: 27%;" width="27%">PROC001 - Configuração Shipay no Serviço Financeiro

</td><td style="border-style: solid; border-color: black; width: 19%;" width="19%"><span style="font-size: small; color: #000000;">N/A</span>

</td><td style="border-style: solid; border-color: black; width: 27%;" width="27%"><span style="font-size: small; color: #000000;">N/A</span>

</td><td style="border-style: solid; border-color: black; width: 27%;" width="27%"><span style="font-size: small; color: #000000;">N/A</span>

</td></tr><tr><td style="border-style: solid; border-color: black; width: 27%;">PROC002 - Configuração do App

</td><td style="border-style: solid; border-color: black; width: 19%;"><span style="font-size: small; color: #000000;">GV, Serviço Financeiro</span>

</td><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;"> Configuração do Pix via Shipay</span>

</td><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;">Validação no serviço e informação salva na base de dados </span>

</td></tr><tr><td style="border-style: solid; border-color: black; width: 27%;">PROC003 - Fluxo PIX Shipay

<div></div></td><td style="border-style: solid; border-color: black; width: 19%;"><span style="color: #000000; font-size: small;">GV, API Shipay</span>

</td><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;">Solicitação de pagamento via PIX</span>

</td><td style="border-style: solid; border-color: black; width: 27%;"><span style="font-size: small; color: #000000;"> Geração do QR Code via Shipay</span>

</td></tr></tbody></table>

#### **Processos Relacionados** 

- - - - - -

[PROC001 - Configuração Shipay no GV](https://docs.softensistemas.com.br/books/tef-android-e-shipay-gerencievendas/page/proc001-configuracao-shipay-no-gv)

[PROC002 - Configuração do App](https://docs.softensistemas.com.br/books/tef-android-e-shipay-gerencievendas/page/proc002-configuracao-do-app)

#### **Especificação Funcional**

- - - - - -

#### **PROC003 - Fluxo PIX *Shipay*:**

##### ***Protótipo de Tela:***

[![image-1767722853562.png](https://docs.softensistemas.com.br/uploads/images/gallery/2026-01/scaled-1680-/image-1767722853562.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2026-01/image-1767722853562.png)

Imagem I - Tela de Pagamento

[![image-1767723579697.png](https://docs.softensistemas.com.br/uploads/images/gallery/2026-01/scaled-1680-/image-1767723579697.png)](https://docs.softensistemas.com.br/uploads/images/gallery/2026-01/image-1767723579697.png)

##### ***Descrição dos Campos:***

<table border="1" cellpadding="7" cellspacing="0" id="bkmrk-campo-tipo-tamanho-o" style="width: 843px;"><tbody><tr valign="top"><td bgcolor="#acb9ca" style="width: 168px; border-style: solid; border-color: black;"><span style="color: #000000;">**Campo**</span>

</td><td bgcolor="#acb9ca" style="width: 102px; border-style: solid; border-color: black;"><span style="color: #000000;">**Tipo**</span>

</td><td bgcolor="#acb9ca" style="width: 88px; border-style: solid; border-color: black;"><span style="color: #000000;">**Tamanho**</span>

</td><td bgcolor="#acb9ca" style="width: 165px; border-style: solid; border-color: black;"><span style="color: #000000;">**Obrig. ?**</span>

</td><td bgcolor="#acb9ca" style="width: 119px; border-style: solid; border-color: black;"><span style="color: #000000;">**Máscara**</span>

</td><td bgcolor="#acb9ca" style="width: 201px; border-style: solid; border-color: black;"><span style="color: #000000;">**Observações**</span>

</td></tr><tr><td style="width: 168px; border-style: solid; border-color: black;"><span style="color: #000000;">QRCode</span>

</td><td style="width: 102px; border-style: solid; border-color: black;"><span style="color: #000000;">-</span>

</td><td style="width: 88px; border-style: solid; border-color: black;"><span style="color: #000000;">-</span>

</td><td style="width: 165px; border-style: solid; border-color: black;"><span style="color: #000000;">-</span>

</td><td style="width: 119px; border-style: solid; border-color: black;">-

</td><td style="width: 201px; border-style: solid; border-color: black;">-

</td></tr><tr><td style="width: 168px; border-style: solid; border-color: black;"><span style="color: #000000;">Consultar Pagamento</span>

</td><td style="width: 102px; border-style: solid; border-color: black;"><span style="color: #000000;">Botão</span>

</td><td style="width: 88px; border-style: solid; border-color: black;"><span style="color: #000000;">-</span>

</td><td style="width: 165px; border-style: solid; border-color: black;"><span style="color: #000000;">-</span>

</td><td style="width: 119px; border-style: solid; border-color: black;">-

</td><td style="width: 201px; border-style: solid; border-color: black;">-

</td></tr></tbody></table>

#####  

#####  

##### ***Regras de Interface:***

***1.*** Se configurado o pagamento via PIX Shipay, ao finalizar uma venda com forma de pagamento PIX deve ser renderizado o QR Code (imagem 2). Caso não seja possível ser feita a renderização do QR Code, retornar aviso em tela e voltar para os pagamentos (imagem 1):

<p class="callout warning">Não foi possível gerar o QR Code, tente novamente.</p>

<span style="color: #000000;">***1.1 Tela de QR Code - Deve conter as seguintes instruções***</span>

> <span style="color: #000000;">Pagamento PIX</span>
> 
> <span style="color: #000000;">1. ABRA O APLICATIVO DO SEU BANCO</span>  
> <span style="color: #000000;">2. ESCOLHA PAGAR COM QR CODE</span>  
> <span style="color: #000000;">3. APONTE A CÂMERA DO APARELHO PARA O QR CODE</span>

<span style="color: #000000;">**1.2 Botão "Consultar Pagamento" deve consultar o status do pagamento na API da Shipay.   
PAGAMENTO REALIZADO:** deve ser finalizado a tela de QR Code, transferindo o usuario para a tela de finalização da venda. Ou se for o caso, repassar para outros pagamentos eletrônicos caso existirem.  
**PAGAMENTO PENDENTE:** Deve ser retornado a mensagem em tela:  
</span>

<p class="callout warning"><span style="color: #000000;">Pagamento PIX pendente!</span></p>

<span style="color: #000000;">**PAGAMENTO EXPIRADO:** Deve retornar o usuário para a tela de pagamentos (imagem 1) e retornar a mensagem:</span>

<p class="callout warning"><span style="color: #000000;">Pagamento PIX expirado!</span></p>

***2. Tempo de espera:*** Passado 1 minuto sem pagamento, deve ser ficar disponível o botão "retornar", para que seja possível ao usuário voltar a tela anterior. (DEFINIR TEMPO)

#### ***Regras de Negócio:***

1\. **Botão Consultar Pagamento** - Deve realizar a requisição na Shipay para retornar o status do QRCode. A solicitação é feita por meio do GET no endereço [https://api-staging.shipay.com.br/order/{order\_id}](https://api-staging.shipay.com.br/order/%7Border_id%7D).

2\. O app deve realizar consultar automáticas de 20 em 20 segundos (DEFINIR).

#### ***Questões Técnicas:***

***1.***

```SQL
ALTER TABLE salePayment ADD COLUMN shipayPayment INT

CREATE TABLE shipayPayment  (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  createdAt DATETIME,
  orderId VARCHAR(100),
  qrCode LONGTEXT,
  status VARCHAR(30)
)


```

Dados a serem usados para teste:  
**Access Key**: bDgEKCRmx0cAynN1Zd-3wg  
**Secret Key**: 4hXzdhTTRkhXlhyZSR6yhGI1Ytj8B9EtTuTAZq6ajn6r-\_hTUi\_ADqRGQ6QxKZbYGbipU3JLmrmxUTJ\_Ibx8gA  
**Client Id**: aYvu\_1ovLdDs5l4GSLFh-XS\_WqSMVclJCLRuOkqLLHXmV0gwu0OSOADsRM2D1fZ8ApUkhDKeJYIWtm9yANKJ8FrcZnFkcGM4YcVFgAGKzbqCmdSkyWqab7m\_RtndTJE4C13Ye0JkcO01Bc-LXn7RZKN\_kn2458wU0U8IJN62T8

Link da Documentação: [https://api-staging.shipay.com.br/docs.html](https://api-staging.shipay.com.br/docs.html)

**URL\_BASE:** [https://api-staging.shipay.com.br](https://api-staging.shipay.com.br/)

##### **Requisição para Geração do QR Code (exemplo):**

**Recurso:**

POST /order

**Header:**

<div id="bkmrk-authorization%C2%A0-%C2%A0-%C2%A0-%C2%A0"><div><svg class="svg-icon" data-icon="link" role="presentation" viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"></svg><div>authorization Token de autorização</div></div></div>x-shipay-order-type Header necessário somente para pedidos de e-commerce, com valor "e-order"

Body

```JSON
{
  "buyer": {
    "cpf_cnpj": "88646743063",
    "email": "[email protected]",
    "name": "Roberto Dias",
    "phone": "(11) 99999-9999"
  },
  "callback_url": "https://7d703c9451be72658b3fdc0dcf820946.m.pipedream.net",
  "items": [
    {
      "ean": "0123456789012",
      "item_title": "batata doce",
      "quantity": 2.1626,
      "sku": "MTC-6110",
      "unit_price": 3.69
    }
  ],
  "order_ref": "pedido-qualquer-123",
  "pix_dict_key": "99999999999",
  "total": 7.98,
  "wallet": "mercadopago"
}
```

**Parâmetros do Corpo da Requisição:**

<table border="1" cellpadding="4" cellspacing="0" id="bkmrk-campo-tipo-obrig.-de" style="height: 1921px;" width="814"><tbody><tr valign="top"><td bgcolor="#b4c7dc" style="width: 202.288px;">**Campo**

</td><td bgcolor="#b4c7dc" style="width: 80.1125px;">**Tipo**

</td><td bgcolor="#b4c7dc" style="width: 66.0875px;">**Obrig.**

</td><td bgcolor="#b4c7dc" style="width: 460.712px;">**Descrição**

</td></tr><tr valign="top"><td style="width: 202.288px;">buyer</td><td style="width: 80.1125px;">object</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">Informações do comprador. Para criar pedidos com expiração, é obrigatório o envio do nome e do CPF ou CNPJ do comprador.

</td></tr><tr valign="top"><td style="width: 202.288px;"> cpf\_cnpj</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">CPF ou CNPJ da pessoa do comprador (PF ou PJ). Deve ser um CPF ou CNPJ válido.

</td></tr><tr valign="top"><td style="width: 202.288px;"> email</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">Endereço de e-mail do comprador

</td></tr><tr valign="top"><td style="width: 202.288px;"> name</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Nome completo do comprador, no caso de PF. Nome da empresa, no caso de PJ.

</td></tr><tr valign="top"><td style="width: 202.288px;"> phone</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">Número de telefone do comprador

</td></tr><tr valign="top"><td style="width: 202.288px;">callback\_url</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">Iremos notificar o "callback\_url" (quando fornecido na requisição de pagamento), via método POST, informando que houve uma alteração no status do pedido. Por questões de segurança, não iremos informar o novo status nesta requisição. Para isto, o PDV deverá consultar nosso endpoint de status de pedidos (GET /order) quando receber nossa notificação. Para que o callback seja considerado confirmado, o PDV deve responder com HTTP Status 200 em até 2 segundos, que é o tempo de timeout da chamada do callback (ver https://docs.shipay.com.br/faq/#callback).</td></tr><tr><td style="width: 202.288px;">items \[</td><td style="width: 80.1125px;">Array of objects (item)</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Lista de itens do pedido. É obrigatório enviar ao menos um item. No caso de pagamento parcial, ver [https://docs.shipay.com.br/faq/#pagamento\_parcial](https://docs.shipay.com.br/faq/#pagamento_parcial).

</td></tr><tr><td style="width: 202.288px;"> ean</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">EAN do item

</td></tr><tr><td style="width: 202.288px;"> item\_title</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Nome do item

</td></tr><tr><td style="width: 202.288px;"> quantity</td><td style="width: 80.1125px;">number</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Quantidade do item

</td></tr><tr><td style="width: 202.288px;"> sku</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">SKU do item

</td></tr><tr><td style="width: 202.288px;"> unit\_price</td><td style="width: 80.1125px;">number</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Valor unitário do item

</td></tr><tr><td style="width: 202.288px;">\]</td><td style="width: 80.1125px;"> </td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;"> </td></tr><tr><td style="width: 202.288px;">order\_ref</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Número de referência do pedido no sistema de PDV

</td></tr><tr><td style="width: 202.288px;">pix\_dict\_key</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;"> </td><td style="width: 460.712px;">Chave PIX da conta bancária que criou o pedido (exemplo: CNPJ, e-mail, telefone, etc.); ver mais em: [https://docs.shipay.com.br/faq/#mais\_de\_um\_pix\_por\_loja](https://docs.shipay.com.br/faq/#mais_de_um_pix_por_loja).

</td></tr><tr><td style="width: 202.288px;">total</td><td style="width: 80.1125px;">number</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Valor total do pedido. Este valor tem que ser igual ao somatório dos valores dos itens

</td></tr><tr><td style="width: 202.288px;">wallet</td><td style="width: 80.1125px;">string</td><td style="width: 66.0875px;">Sim</td><td style="width: 460.712px;">Enum: `"mercadopago"` `"picpay"` `"ame"` `"pagseguro"` `"cielo"` `"pix"`  
Nome da carteira digital</td></tr></tbody></table>

**Exemplo de Retorno (JSON):**

```JSON
{
  "deep_link": "null",
  "order_id": "652f385f-91f4-48cd-8e56-1fc6dec21526",
  "pix_dict_key": "c7640914-46Fe-4c7d-8664-cf77e8bfeb5c",
  "pix_psp": "bb",
  "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAmIAAAJiAQAAAABMLZNLAAAGB0lEQVR4nO2dX4rcOBDGv1ob+tENc4A5in2DHCnkSLmBfZQcYEF+DLipfZBKVXI2O1mYaUbm04OZsdo/bHC5VH8livcb21/vCANII4000kgjjTTSSCONtM9AkzJGAPsIWfJBJM8uAIBdwgD2MZ5bPuzeSCPtqbRZVVUTAEwHdJ2OfF7k/hBsd0DkVVU1DQrk2YcAGFRVVVva+94baaQ9lbaXb7ss+whsIqLrpArsN8WcANUfIlkM5jQottcqLjJ+7L2RRtozaMif9TmhvOP5oz/ZuaImVDGnwfQC7Mf5CgyaFcv6mZ+UNNL+e4znE/MKFezjge31GBX7TQWQMrstAzB/fzmw3Qco9o+8N9JIeybN9IJGY0BXswNU9cjWBOb812GXmZoIAOoF0vqnbSIicgcw/7ipfE3FcpBlv6n5jG7VfBhUFgCy4GFupY+7N9JIewoN2g5zEhU7QFeg6gVVXc18yEpkbi+mXiCtY1q0nbOHNKEuhcwwBoBiXod104F4GWWBtM5pjSxkF9IB1wblvU8ozqTiUy32gikR0y6UBdI6ptlbnNdDg+YF0IpBs2M1e1ddB4SX/4BrCMoCad3Tik91TndRTH8L5gRIDirvAgCPUbG/qACAbl8Axf5yyL/SPvOTkkbaG8PWSMVUyJ96AHmh5MG1uG5KyGka8S/qBdI6p8U1kloYwcWg+IyquKyoMpNsGZXNB8oCaZ3T7C2ean6d2c7BWA4/btI0TGswB4O0C9CqXgAalVDXSMGJqtXjavZ0cCtRFkjrnGZve/JYQk3Bq95VmG/JHEytzEwmKZQF0jqmBb1g6aiNnbxW0SiJqWhSVM3jSr1AWve0mptnZkEbT7a4WvnXTemsIWbm5pF2GVrIU7VM1GaEjNUE5OVRDrMlC7itoL1A2gVo1Y9UvUcAolSkaBHkA4LTqVjWlAXSuqcVvRD8opMGF2upfK7aoEhFqxxsoURZIK1nWvAjxRRVFwg/INoGwbfkHlfKAmkd04Je8IWSVzm76zTmcdekC7Vz1AukdU+rsmBjtswL1wZlQluPq3cBoL1A2hVorR9JLZDWuIvKRI21lUBzY09zjURa7zTrg7G/HHa4qWACAAwqYRYP0VkB3e7DUWb3lwOb529/5icljbQ/om13wHLufkr+/G8yBvMhx9826wsmCx7WOkyrmdHBk5JG2u9G8Kn6OIUW8rmQwn2EwgYPPnONRFrPtFDvHJLsaiwhdEDyRquzOZHM40rbmbQL0M55qhZmq3ay1tZhVssTpSI1FMoCaR3TYp6qRwvqKx8q11bXAec8VRuUBdI6prV1bVbbrNVeKFU9bXi5NsMo0TnaC6RdgBYCyHG1NKkVLDQS4DmpQS+UBD3KAml905rcvBT7Hlnt/6k5mMb0Pe9Dz1gbab3TYg7G3KSeujHgqdmx7N+WVlbJQFkg7Qq0Uqiz37KGkAUP0TXv0DPGurZiNj8EZY+qsnmVLB92b6SR9hxarPGsSXauIX7ZecdjDgmIv6NeIK1zWuwJA+ui6qa0W9HnFjEhi3Vibh5pF6AF/2noarGGZFWbddURZpNb25QF0vqmxRyMkoBU3akptk09+YzK1RNjbaRdhRb3Lty+HCOwj4eWjQmHA3N6QDAdowI/JWexbgIo8BhRDoDM6/vfG2mkPZNWzYJTf6S4G8/Jf+rxN7+CeoG07mnnPtuekeezbiXkUeXDWuuBfiTS+qc1ORi1i2rYmLBqiBJyrjtYpYpgzjZpV6D9so9n2aKwek1rmzDvE5N1QDNBvUBa97S2D4bv19YUNszVe9Ru2ubpe9QLpF2FNlsYQb7+EPEFUN7/PL/8+wj9do/NME47lXTxpKSR9gZtF5Glns2tAHaR7DjaRHICknzVo0x8uw9qE0C5tocnJY2034xoJbTZqXOqxW3wWgWr7CwV/9zTlrSr0H6VBbS7E4a+eZ6F5E2HWftP2lVoMVDg1f1tSZvvU1gUQW0CE3yvlAXSOqed/Uhhl7ZqHceogimRsn1bU/dJWSCtZ5ro27/547F95icljTTSSCONNNJII4000v7v+Ac9gr62lMM5YQAAAABJRU5ErkJggg==",
  "qr_code_text": "00020101021226850014br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/70fcfe1e-f583-4dc7-87fa-924dba5247eb52040000530398654040.015802BR5915loja da ***6304A161",
  "status": "pending",
  "wallet": "mercadopago"
}
```

**Parâmetros do Retorno:**

<table border="1" cellpadding="4" cellspacing="0" id="bkmrk-campo-tipo-descri%C3%A7%C3%A3o"><tbody><tr valign="top"><td bgcolor="#b4c7dc" style="width: 133px;">**Campo**

</td><td bgcolor="#b4c7dc" style="width: 74px;">**Tipo**

</td><td bgcolor="#b4c7dc" style="width: 602px;">**Descrição**

</td></tr><tr valign="top"><td style="width: 133px;">deep\_link</td><td style="width: 74px;">string</td><td style="width: 602px;">URL que redireciona o usuário para o aplicativo da carteira digital. No caso de pedidos PIX, esse campo retorna "null".

</td></tr><tr valign="top"><td style="width: 133px;">order\_id</td><td style="width: 74px;">string</td><td style="width: 602px;">ID do pedido na Shipay

</td></tr><tr valign="top"><td style="width: 133px;">pix\_dict\_key</td><td style="width: 74px;">string</td><td style="width: 602px;">Chave PIX da conta bancária que criou o pedido (exemplo CNPJ, e-mail, telefone, etc.). No caso de pedidos com carteiras digitais, este objeto tem o valor "null".

</td></tr><tr valign="top"><td style="width: 133px;">pix\_psp</td><td style="width: 74px;">string</td><td style="width: 602px;">Enum: `"itau"` `"original"` `"santander"` `"mercadopago"` `"pagseguro"` `"bb"` `"bradesco"`  
Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança PIX foi gerada. No caso de pedidos realizados com carteiras digitais (não PIX), o retorno é "null".</td></tr><tr valign="top"><td style="width: 133px;">qr\_code</td><td style="width: 74px;">string</td><td style="width: 602px;">QR Code em imagem, codificado em Base64

</td></tr><tr valign="top"><td style="width: 133px;">qr\_code\_text</td><td style="width: 74px;">string</td><td style="width: 602px;">QR Code em formato de texto (facilita a impressão do QR Code em impressora térmica). No caso de PIX, esse campo é o código utilizado para a funcionalidade "copia e cola".

</td></tr><tr><td style="width: 133px;">status</td><td style="width: 74px;">string</td><td style="width: 602px;">Status do pedido/pagamento. Neste caso, o único status possível é:

pending - Pedido aberto e ainda não pago ou cancelado

</td></tr><tr><td style="width: 133px;">wallet</td><td style="width: 74px;">string</td><td style="width: 602px;">Enum: `"mercadopago"` `"picpay"` `"ame"` `"pagseguro"` `"cielo"` `"pix"`  
Nome da carteira digital na qual o pedido foi criado. No caso de PIX, o valor desse campo é "pix", independente do provedor de serviço de pagamentos (PSP).</td></tr></tbody></table>

##### **Requisição para Consulta de Status (exemplo):**

**Recurso:**

GET /order/{order\_id}

**Path:**

order\_id ID do pedido na Shipay

**Header:**

authorization Example: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MDM4MzI3NjUs...`  
 Token de autorização

**Exemplo de Retorno (JSON):**

```JSON
{
  "created_at": "07-10-2020 17:35:53",
  "external_id": "pedido-qualquer-123",
  "items": [
    {
      "ean": "123456789012",
      "item_title": "batata doce",
      "quantity": 2.1626,
      "sku": "AA-AAA-000",
      "unit_price": 3.69
    }
  ],
  "order_id": "f92d30a8-499d-4f46-bcf2-8d689ad7b5f7",
  "paid_amount": 7.98,
  "payment_date": "07-10-2020 17:45:51",
  "pix_psp": "itau",
  "status": "cancelled",
  "total_order": 7.98,
  "updated_at": "07-10-2020 17:42:06",
  "wallet": "pix",
  "wallet_payment_id": "E60736948202104381456C3987yL7T9s"
}
```

**Parâmetros do Retorno:**

<table border="1" cellpadding="4" cellspacing="0" id="bkmrk-campo-tipo-obrig.-de-0"><tbody><tr valign="top"><td bgcolor="#b4c7dc" style="width: 138px;">**Campo**

</td><td bgcolor="#b4c7dc" style="width: 161px;">**Tipo**

</td><td bgcolor="#b4c7dc" style="width: 510px;">**Descrição**

</td></tr><tr valign="top"><td style="width: 138px;">created\_at</td><td style="width: 161px;">string</td><td style="width: 510px;">Data e horário da criação do pedido</td></tr><tr valign="top"><td style="width: 138px;">external\_id</td><td style="width: 161px;">string</td><td style="width: 510px;">Número de referência do pedido no sistema de PDV

(igual ao 'order\_ref' do **POST** **/order**)

</td></tr><tr valign="top"><td style="width: 138px;">items \[</td><td style="width: 161px;">Array of objects (Item)</td><td style="width: 510px;">Lista de itens do pedido</td></tr><tr valign="top"><td style="width: 138px;"> ean</td><td style="width: 161px;">string</td><td style="width: 510px;">EAN do item

</td></tr><tr><td style="width: 138px;"> item\_title</td><td style="width: 161px;">string</td><td style="width: 510px;">Nome do item

</td></tr><tr><td style="width: 138px;"> quantity</td><td style="width: 161px;">number</td><td style="width: 510px;">Quantidade do item

</td></tr><tr><td style="width: 138px;"> sku</td><td style="width: 161px;">string</td><td style="width: 510px;">SKU do item

</td></tr><tr><td style="width: 138px;"> unit\_price</td><td style="width: 161px;">number</td><td style="width: 510px;">Valor unitário do item

</td></tr><tr><td style="width: 138px;">\]</td><td style="width: 161px;"> </td><td style="width: 510px;"></td></tr><tr><td style="width: 138px;">order\_id</td><td style="width: 161px;">string</td><td style="width: 510px;">ID do pedido na Shipay

</td></tr><tr><td style="width: 138px;">paid\_amount</td><td style="width: 161px;">number</td><td style="width: 510px;">Valor pago pelo cliente. Utilizado para o PDV verificar se o valor pago é igual ao valor do pedido.

</td></tr><tr><td style="width: 138px;">payment\_date</td><td style="width: 161px;">string</td><td style="width: 510px;">Data do pagamento (data e horário)

</td></tr><tr><td style="width: 138px;">pix\_psp</td><td style="width: 161px;">string</td><td style="width: 510px;">Enum: `"itau"` `"original"` `"santander"` `"mercadopago"` `"pagseguro"` `"bb"` `"bradesco"`  
Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança PIX foi gerada. No caso de pedidos realizados com carteiras digitais (não PIX), o retorno é "null".

</td></tr><tr><td style="width: 138px;">status</td><td style="width: 161px;">string</td><td style="width: 510px;">Status do pedido/pagamento. Neste caso, os status possíveis são:

<table border="1"><tbody><tr><td style="width: 126px;">**status**</td><td style="width: 366px;">**descrição**</td></tr><tr><td style="width: 126px;">pending</td><td style="width: 366px;">Pedido aberto e ainda não pago ou cancelado</td></tr><tr><td style="width: 126px;">pendingv</td><td style="width: 366px;">Pedido aberto e ainda não pago ou cancelado (para pedidos com vencimento criados através do POST /orderv)</td></tr><tr><td style="width: 126px;">approved</td><td style="width: 366px;">Pedido aprovado na carteira digital</td></tr><tr><td style="width: 126px;">cancelled</td><td style="width: 366px;">Pedido (ainda não pago) cancelado na carteira digital</td></tr><tr><td style="width: 126px;">expired</td><td style="width: 366px;">Pedido expirado após 60 minutos com status "pending"</td></tr><tr><td style="width: 126px;">refunded</td><td style="width: 366px;">Pagamento devolvido ao comprador</td></tr><tr><td style="width: 126px;">refund\_pending</td><td style="width: 366px;">Pagamento com devolução solicitada. Status aplicável para PIX e para a carteira digital Cielo Pay pois a ação de devolução não é síncrona nestes casos. No caso de PIX a devolução deve ser efetivada em até 90 segudos após a solicitação. No caso da Cielo Pay, a devolução ocorre sempre no dia seguinte à solicitação. Em ambos os casos, quando a devolução é efetivada, o status na Shipay é alterado para "refunded"</td></tr></tbody></table>

</td></tr><tr><td style="width: 138px;">total\_order</td><td style="width: 161px;">number</td><td style="width: 510px;"></td></tr><tr><td style="width: 138px;">updated\_at</td><td style="width: 161px;">string</td><td style="width: 510px;"></td></tr><tr><td style="width: 138px;">wallet</td><td style="width: 161px;">string</td><td style="width: 510px;"></td></tr><tr><td style="width: 138px;">wallet\_payment\_id</td><td style="width: 161px;">string</td><td style="width: 510px;"></td></tr></tbody></table>

©SOFTEN SISTEMAS 2026