LYNX UPBANK · Tecnologia de pagamentos Pix & Crypto

Consultar cobrança

GET/v1/pixQrCode/check

Retorna o status atual de uma cobrança PIX. Use como reforço, o caminho recomendado é o webhook pixQrCode.paid.

Permissão necessária: PIX:READ

Parâmetros

Parâmetro	Tipo	Descrição
`id`obrig.	string	ID da cobrança (query string).

Boas práticas

Se fizer polling, consulte a cada 5–10 segundos no máximo, cada consulta consome seu rate limit.
Trate PAID como estado final: não reprocesse um pedido já entregue (idempotência).

Requisição

bash

curl -X GET https://lynxpix.cc/api/v1/pixQrCode/check?id=chg_9f8a2c1e \
  -H "Authorization: Bearer lynx_test_sua_chave"

Resposta

json

{
  "data": {
    "id": "chg_9f8a2c1e",
    "status": "PAID",
    "amount": 4990,
    "paidAt": "2026-07-01T12:03:11Z",
    "payer": {
      "name": "Maria Souza",
      "document": "12345678900",
      "documentMasked": "***.456.789-**",
      "bank": "NU PAGAMENTOS"
    },
    "endToEndId": "E18935924202607011203apiv1x9f8a2"
  },
  "error": null
}