LYNX UPBANK · Tecnologia de pagamentos Pix & Crypto

Consultar boleto

GET/v1/boleto/check

Retorna o status atual de um boleto. Use como reforço, o caminho recomendado é o webhook boleto.paid.

Permissão necessária: BOLETO:READ

Parâmetros

Parâmetro	Tipo	Descrição
`id`obrig.	string	ID do boleto (query string).

Boas práticas

Pagamento pela linha digitável em outro banco pode levar até 1 dia útil para compensar: não trate PENDING como falha.
Em modo teste, use POST /v1/boleto/simulate-payment para marcar como pago e disparar o webhook boleto.paid.

Requisição

bash

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

Resposta

json

{
  "data": {
    "id": "bol_9f8a2c1e",
    "kind": "boleto",
    "method": "BOLETO",
    "status": "PAID",
    "amount": 15000,
    "paidAt": "2026-07-16T10:03:11Z",
    "boleto": {
      "digitableLine": "74891160090000642205902991121050115340000000500",
      "dueDate": "2026-07-18T02:59:59Z"
    },
    "payer": {
      "name": "João da Silva",
      "documentMasked": "***.456.789-**"
    }
  },
  "error": null
}