Listar boletos

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Introdução

Endpoint para listagem de boletos de cash-in de uma conta pela data de vencimento e status

Detalhe importante: É preciso que o usuário possua uma conta associada ao nosso sistema.

Autenticação

Para que seja possível integrar com a API é necessário informar o token através do header da requisição com o tipo Bearer Token. Esta infrormação é obrigatória e caso não seja informada durante a requisição, a API responderá com um 403 - Forbidden.

Documentação para realizar a autenticação

Params

ParâmetroObrigatórioDescrição
data_inicioSimparâmetro {data_inicio} Data de vencimento inicial
DD-MM-AAAA
data_fimSim(parâmetro {data_fim} Data de vencimento final.
DD-MM-AAAA
statusNãoArray (parâmetro {status[]} do boleto, A "ABERTO", B "BAIXADO", P "PAGO", R "REGISTRADO", se não informado retornará boletos com todos os status.
pagenãoA página (parâmetro {page}) na qual se deseja visualizar os dados da pesquisa
sizenãoQuantidade de registros (parâmetro {size}) que se deseja exibir dela

Status possíveis

StatusDescrição
NEWBoleto novo
OPENBoleto em aberto
REGISTEREDBoleto registrado
PAIDBoleto pago
SETTLEDBoleto liquidado
OVERDUEBoleto vencido
WRITE_OFFBoleto baixado
CANCELEDBoleto cancelado
Query Params
int32
Defaults to 0
int32
Defaults to 20
date
required
Defaults to 2023-01-20
date
required
Defaults to 2023-02-10
string
enum
Defaults to NEW
Headers
string
required
Defaults to fbf81b49-05d2-4108-a19b-4c66953556dc

Identificador da conta

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json