Boleto
Consultar boleto
Consulte um boleto por correlationId ou liste cobranças por período com paginação.
GET
Para o passo a passo completo, veja o guia Consultar Boleto.
Consultar por correlationId
GET /baas/v1/charges/:correlationId
Headers
string
required
Sua API key.
string
required
Número da conta Delfinance.
Path
string
required
GUID do boleto informado na criação.
Consulta paginada por período
GET /baas/v1/charges?startDate=&endDate=&page=&limit=
Query params
string
required
Data inicial no formato
YYYY-MM-DD.string
required
Data final no formato
YYYY-MM-DD. Intervalo máximo: 1 ano.number
Número da página (começa em 1).
number
Itens por página — máximo 100.
Response
string
Tipo:
BANKSLIP ou BANKSLIP_PIX.string
GUID de conciliação.
number
Valor do boleto.
string
Carteira:
"112" ou "121".string
Número do documento.
string
Nosso número.
string
Data de vencimento em ISO 8601.
string
Código de barras.
string
Linha digitável.
object
Dados do pagador.
object
Dados do beneficiário (cedente).
object
Configuração de desconto por antecipação, se aplicável.
object
Configuração de multa, se aplicável.
object
Configuração de juros, se aplicável.
string
Status atual:
Pending, Paid, Expired ou Cancelled.array
Histórico de pagamentos registrados.
string
Data/hora de criação em ISO 8601.
string
Data/hora da última atualização em ISO 8601.

