Consultar Boleto por Período
Esse endpoint consulta boletos por período.
Exemplo de Resposta - Endpoint
[
{
"id": "9FAE4...",
"value": "10000",
"webhook_url": null,
"end_to_end_id": null,
"payer_name": "João da Silva",
"payer_national_registration": null,
"link_boleto": "https://...",
"link_download": "https://...",
"status": "created" | "paid" | "canceled",
"qr_code": "0002010...",
"digitable_line": "4359000116...",
"our_number": "0000056..."
}
]
📝 Descrição dos Campos
Parametro | Tipo | Descrição |
| string | Data de início YYYY-MM-DD |
| string | Data final YYYY-MM-DD |
Header Parameters
Authorizationstring Required
Colocar no formato Bearer TOKEN
Acceptstring Required
application/json
Content-Typestring Required
application/json
Query Parameters
start_datestring
Data de início
end_datestring
Data final
Response
200
Object
[
{
"id": "9FAE4...",
"value": "10000",
"webhook_url": null,
"end_to_end_id": null,
"payer_name": "João da Silva",
"payer_national_registration": null,
"link_boleto": "https://...",
"link_download": "https://...",
"status": "created" | "paid" | "canceled",
"qr_code": "0002010...",
"digitable_line": "4359000116...",
"our_number": "0000056..."
}
]
400
Object
Bad Request -- Composição do request inválido
401
Object
Unauthorized -- Chave TOKEN inválida
403
Object
Forbidden -- Apenas administradores
404
Object
Not Found -- Pedido não existe
405
Object
Method Not Allowed -- Método não permitido
406
Object
Not Acceptable -- Formato JSON inválido
410
Object
Gone -- Essa requisição não existe mais
418
Object
I'm a teapot.
429
Object
Too Many Requests -- Muitas requisições em um curto espaço de tempo
500
Object
Internal Server Error -- Favor tente mais tarde
503
Object
Service Unavailable -- Estamos temporariamente inativos, favor aguardar.
Was this section helpful?
What made this section unhelpful for you?
Base URL
Production:
Sandbox:
Response
Was this section helpful?
What made this section unhelpful for you?