Endpoint para consulta do comprovante de pagamento do boleto.


Path Variable do request

CampoTipo(Tamanho)ObrigatórioDescrição
referenceString (21)SimCódigo de referência do pagamento.

Corpo do response

CampoTipoDescrição
accountIdentifierUUIDIdentificador da conta pagadora.
statusStringStatus do pagamento. Status padrão: PAID
recipientDocumentNumberStringNúmero do documento do beneficiário do boleto. Para pagamento de convênio e tributos será enviado sempre null
recipientNameStringNome do beneficiário do boleto. Para pagamento de convênio e tributos será enviado sempre null
originalPayerStringNome do pagador original do boleto. Para pagamento de convênio e tributos será enviado sempre null
originalPayerDocumentNumberStringNúmero do documento do pagador original do boleto. Para pagamento de convênio e tributos será enviado sempre null
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.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!