Skip to content

Consultar Pedido pelo Link de Pagamento

GET /publics/order/payment-code/{code}

Retorna os dados completos de um pedido a partir do código de link de pagamento.

Endpoint público responsável por retornar os dados completos de um pedido a partir do código de um link de pagamento, para renderização da tela de checkout apresentada ao cliente final.

Junto com os dados do pedido, retorna também as formas de pagamento disponíveis para conclusão da compra — já filtradas pela allowlist definida no momento da geração do link (parcelas, desconto à vista, etc, calculados em tempo real).

O acesso é anônimo — não exige autenticação de cliente. O código em si é o único segredo que protege o acesso a esses dados.

---

Validações

A consulta é recusada quando:

  • O código informado não existe.
  • O link já expirou.
  • O pedido vinculado não está mais aguardando pagamento (já foi pago, cancelado, etc).

ParâmetroTipoObrigatórioDescrição
codestringSimCódigo público do link de pagamento.

1curl --request GET \
2  --url 'https://sua-loja-uappi.com.br/api/v3/publics/order/payment-code/a1b2c3d4e5f6'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "code": "a1b2c3d4e5f6",
5    "expiresAt": "2026-08-29 14:30:06",
6    "orderGroup": {
7      "id": 345,
8      "code": "345",
9      "currency": "BRL",
10      "salesChannelDomain": "sua-loja.com.br",
11      "customer": {
12        "customerId": 0,
13        "nameCorporateName": "Mariana Souza",
14        "email": "mariana.souza@cliente.com",
15        "document": "12345678909",
16        "phone": "+5511998765432"
17      },
18      "addresses": [
19        {
20          "type": "delivery",
21          "zipCode": "12123-123",
22          "street": "Rua das Flores",
23          "number": "120",
24          "city": "São José dos Campos",
25          "state": "São Paulo",
26          "stateCode": "SP"
27        }
28      ],
29      "values": {
30        "subtotalValue": 259.9,
31        "shippingValue": 18.4,
32        "discountValue": 15,
33        "totalValue": 263.3
34      },
35      "orders": [
36        {
37          "orderId": 1,
38          "items": [
39            {
40              "productId": 1,
41              "sku": "SKU-001",
42              "name": "Tênis Running Pro",
43              "quantity": 2,
44              "unitValue": 129.95
45            }
46          ]
47        }
48      ]
49    },
50    "paymentOptions": [
51      {
52        "option": {
53          "paymentOption": {
54            "id": 1,
55            "label": "Cartão de Crédito"
56          },
57          "cashDiscount": null,
58          "installments": [
59            {
60              "installment": 1,
61              "installmentValue": 263.3,
62              "totalValue": 263.3,
63              "fee": 0,
64              "feeTotalValue": 0
65            }
66          ],
67          "error": null
68        }
69      }
70    ]
71  }
72}

CampoTipoDescrição
codestringCódigo público do link de pagamento.
expiresAtdateData/hora de expiração do link.
orderGroupobjectDados completos do pedido (cliente, endereços, valores, itens).
paymentOptionsarrayFormas de pagamento disponíveis para conclusão do pagamento, já filtradas pela allowlist do link.

⚠️ Possíveis erros:

Código InternoCódigo HttpDescrição
UAPPI_STORE_ORDER_PAYMENT_CODE_NOT_FOUND404O código de link de pagamento informado não foi encontrado.
UAPPI_STORE_ORDER_PAYMENT_CODE_EXPIRED400O link de pagamento já expirou.
UAPPI_STORE_ORDER_PAYMENT_CODE_INVALID_ORDER_STATUS409O pedido vinculado ao link não está mais aguardando pagamento (já foi pago, cancelado, etc).

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;