correlationId (consulta individual) ou por período com paginação (consulta em lote para conciliação).
Consultar por correlationId
Retorna os dados completos de um boleto específico, incluindo os encargos configurados e o histórico de pagamentos.payments será preenchido com os dados da liquidação.
Consulta paginada por período
Retorna uma lista de boletos criados dentro do intervalo de datas informado. Útil para conciliação financeira e geração de relatórios.cURL
Parâmetros de query
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
startDate | string | Sim | Data inicial no formato YYYY-MM-DD |
endDate | string | Sim | Data final no formato YYYY-MM-DD. Máximo: 1 ano de intervalo |
page | number | Não | Página (começa em 1) |
limit | number | Não | Itens por página — máximo 100 |
O intervalo máximo permitido entre
startDate e endDate é de 1 ano. Para períodos maiores, faça múltiplas consultas.payments expandido.
Referência da API
Consultar boleto
GET /baas/v1/charges/:correlationId e GET /baas/v1/charges?startDate=&endDate=
