Consulta um pagamento de conta

Tipos de pagamento de contas:
0 - Undefined
1 - Concessionaria
2 - FichaCompensacao



Nesta etapa retornaremos os dados do registro consultado, por meio de sua linha digitável ou código de barras. Para mais informações de como realizar a implementação dessa api, criamos o artigo

DADOS REQUEST AUTHORIZE

CampoTipoObrigatoriedadeDescrição
externalTerminalString (50)🟡 Não obrigatório
externalNSUInt🟡 Não obrigatório
typeString (1)🟡 Não obrigatório
digitableString (48)✅ Obrigatório
barcodeString (50)✅ Obrigatório

DADOS RESPONSE AUTHORIZE

CampoTipoObrigatoriedadeDescrição
assignorString (100)✅ ObrigatórioCedente do pagamento consultado
documentRecipientString (18)✅ ObrigatórioCPF ou CNPJ do beneficiário
documentPayerString (18)✅ ObrigatórioCPF ou CNPJ do pagador
payDueDateDatetime✅ ObrigatórioData de baixa do boleto
nextBusinessDayDatetime✅ ObrigatórioPróximo dia útil
dueDateRegisterDatetime✅ ObrigatórioData de vencimento do registro
allowChangeValueBool✅ ObrigatórioPermissão de alteração do valor do boleto
recipientString (100)✅ ObrigatórioNome do beneficiário
payerString (100)✅ ObrigatórioNome do pagador
discountValueDouble✅ ObrigatórioValor do desconto calculado
interestValueCalculatedDouble✅ ObrigatórioValor juros já calculado
maxValueDouble✅ ObrigatórioValor máximo permitido para pagamento do título
minValueDouble✅ ObrigatórioValor mínimo permitido para pagamento do título
fineValueCalculatedDouble✅ ObrigatórioValor multa já calculado
originalValueDouble✅ ObrigatórioValor nominal do título
totalUpdatedDouble✅ ObrigatórioValor atualizado a ser pago do título
totalWithDiscountDouble✅ ObrigatórioValor total de descontos e abatimentos
totalWithAdditionalDouble✅ ObrigatórioValor total de juros e multa
settleDateDatetime✅ ObrigatórioInforma a data em que o pagamento será enviado para liquidação
dueDateDatetime✅ ObrigatórioRetorna a data de vencimento extraída do código
endHourString (5)✅ ObrigatórioInforma a Hora corte do convênio (HH:MM)
initeHourString (5)✅ ObrigatórioInforma a Hora recebimento Inicial do convênio (HH:MM)
nextSettleString (1)✅ ObrigatórioInforma se o título será liquidado no próximo dia útil
transactionIdInt✅ ObrigatórioProtocolo de identificação da operação
valueDouble✅ ObrigatórioValor extraído do código
errorCodeString (3)✅ ObrigatórioDefine o código status da operação
messageString (100)🟡 Não obrigatórioInforma descrição do erro
statusString (30)✅ ObrigatórioDefine o status da operação
Language
Authorization
Header
Click Try It! to start a request and see the response here!