Listar Boletos

GET /boletos

Lista boletos de um issuer com paginação e filtros.

Autenticação

x-api-key: {apiKey}

Query Parameters

Parâmetro	Tipo	Obrigatório	Descrição
issuerId	string	✅	ID da empresa
status	string		Filtrar: PENDING, REGISTERED, PAID, OVERDUE, CANCELED, ERROR
pagadorCpfCnpj	string		Filtrar por CPF/CNPJ do pagador
page	number		Página (padrão: 1)
limit	number		Itens por página (padrão: 20)

Exemplo

curl "https://api.engineapi.com.br/boletos?issuerId=ISSUER_ID&status=REGISTERED&page=1&limit=10" \
  -H "x-api-key: SUA_API_KEY"

Resposta (200)

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "nossoNumero": "000001234",
      "valor": 250.0,
      "vencimento": "2026-03-15",
      "status": "REGISTERED",
      "pagadorNome": "João da Silva",
      "pagadorCpfCnpj": "12345678909"
    }
  ],
  "total": 15,
  "page": 1,
  "limit": 10
}