get https://api-stg.tbanks.com.br/bill-payment/receipt/list/page
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âmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
startDate | Não | LocalDate | Data de pagamento inicial da consulta ex: AAAA-MM-DD |
endDate | Não | LocalDate | Data de pagamento final da consulta ex: AAAA-MM-DD |
minValue | Não | Double | Valor mínimo do pagamento |
maxValue | Não | Double | Valor máximo do pagamento |
page | Não | int | Páginas obs: por default é '0' |
size | Não | int | Quantidade obs: por default é '20' |
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:
Campo | Tipo | Descrição |
---|---|---|
accountIdentifier | UUID | Identificador da conta pagadora. |
status | String | Status do pagamento. Status padrão: PAID |
recipientDocumentNumber | String | Número do documento do beneficiário do boleto. Para pagamento de convênio e tributos será enviado sempre null |
recipientName | String | Nome do beneficiário do boleto. Para pagamento de convênio e tributos será enviado sempre null |
originalPayer | String | Nome do pagador original do boleto. Para pagamento de convênio e tributos será enviado sempre null |
originalPayerDocumentNumber | String | Número do documento do pagador original do boleto. Para pagamento de convênio e tributos será enviado sempre null |
dueDate | Date | Data de vencimento do boleto. |
paymentDate | DateTime | Data de pagamento do boleto. |
settlementDate | Double | Data da compensação do boleto. Em feriados e finais de semana, será retornada o próximo dia útil. |
issuerBank | String | Nome do banco emissor do boleto. |
value | Double | Valor pago do boleto. |
reference | String | Código de referência da consulta. |
paymentDetail | String | Mensagem do boleto enviado no request. |