Lista de comprovantes

Endpoint para consulta de lista paginada de comprovantes de pagamentos de boletos de uma conta.

Endpoint para consulta de lista paginada de comprovantes de pagamentos de boletos de uma conta .

Obs: Informar o Bearer token no header da requisição

Parâmetros para filtro

parâmetroObrigatórioTipoDescrição
startDateNãoLocalDateData de pagamento inicial da consulta
ex: AAAA-MM-DD
endDateNãoLocalDateData de pagamento final da consulta
ex: AAAA-MM-DD
minValueNãoDoubleValor mínimo do pagamento
maxValueNãoDoubleValor máximo do pagamento
pageNãointPáginas
obs: por default é '0'
sizeNãointQuantidade
obs: por default é '20'
nameNãoStringNome do beneficiário

Obs: se não informar parâmetros serão retornados todos os pagamentos por conta

Corpo do response

Uma lista paginada do objeto detalhado por campos abaixo:

CampoTipoDescrição
accountIdentifierUUIDIdentificador da conta pagadora.
statusStringStatus do pagamento. Status padrão: PAID
recipientDocumentNumberStringNúmero do documento do beneficiário do boleto.
recipientNameStringNome do beneficiário do boleto.
originalPayerStringNome do pagador original do boleto.
originalPayerDocumentNumberStringNúmero do documento do pagador original do boleto.
dueDateDateData de vencimento do boleto.
paymentDateDateTimeData de pagamento do boleto.
settlementDateDoubleData da compensação do boleto. Em feriados e finais de semana, será retornada o próximo dia útil.
issuerBankStringNome do banco emissor do boleto.
valueDoubleValor pago do boleto.
referenceStringCódigo de referência da consulta.
paymentDetailStringMensagem do boleto enviado no request.
nsuPartnerStringNSU do parceiro.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!