Pular para o conteúdo principal

Consultar Boleto

GET /boletos/:id

Retorna os dados completos de um boleto.

Autenticação​

x-api-key: {apiKey}

Parâmetros de URL​

CampoTipoDescrição
idstringID (UUID) do boleto

Exemplo​

curl https://api.engineapi.com.br/boletos/uuid-do-boleto \
  -H "x-api-key: SUA_API_KEY"

Resposta (200)​

{
  "success": true,
  "data": {
    "id": "uuid-do-boleto",
    "nossoNumero": "000001234",
    "valor": 250.0,
    "vencimento": "2026-03-15",
    "status": "REGISTERED",
    "linhaDigitavel": "75691.23456...",
    "codigoBarras": "75691234567...",
    "pixQrCode": "data:image/png;base64,...",
    "pixCopiaECola": "00020126580014...",
    "pagadorNome": "João da Silva",
    "pagadorCpfCnpj": "12345678909",
    "createdAt": "2026-02-10T10:00:00Z"
  }
}