API Reference
Log In

Registra um boleto

Este endpoint retorna os dados do boleto inserido

Respostas das requisições​

Você receberá na resposta da requisição todos os dados do boleto e o id criado para o mesmo.

As variáveis de retorno são listadas abaixo:

VariávelTipoDescrição
idIntegerID gerado no registro do boleto
tidIdStringCódigo para autenticação do boleto
barCodeStringCódigo de barras do boleto
bankUSNStringCódigo usn gerado
authorizerUsnStringCódigo de autorização gerado
serviceDateTimeStringData de execução do serviço
createdDateStringData do momento da criação do registro
paymentValueCentsIntegerValor total de pagamento do boleto
fineAmountStringValor de multa aplicada
interestAmountStringValor de juros aplicado
deductionsAmountStringValor de desconto aplicado
originalAmountIntegerValor original do boleto
expirationDateStringData de validade do boleto
issuerNameStringNome do emissor do boleto
transferorNameStringNome do cedente do boleto
recipientLegalDocumentStringDocumento do recebedor
recipientSocialNameStringNome social do recebedor
recipientBusinessNameStringRazão social do recebedor
payerLegalDocumentStringDocumento do pagador
payerSocialNameStringNome social do pagador
payerBusinessNameStringRazão social do pagador
payeeLegalDocumentStringDocumento do beneficiário
payeeSocialNameStringNome social do beneficiário
payeeBusinessNameStringRazão social do beneficiário
statusStringStatus do pagamento do boleto
additionsAmountStringValor de encargos, acréscimos em centavos

Tipo de leitura do código de barras​

O tipo de leitura do código de barras que pode ser feito é:

TipoDescrição
TYPEDCódigo de barras digitado
SCANNEDCódigo de barras escaneado

Tipos de status do código de barras​

Os tipos de status do código de barras que podem ser são:

StatusDescrição
STARTEDPagamento de boleto iniciado.
CONFIRMEDPagamento de boleto finalizado.
Language
Click Try It! to start a request and see the response here!