API Reference
Log In

Emitir boleto

Endpoint para emissão de boleto único por parceiros da Justa.

Resposta da requisição

VariávelTipoDescrição
idstringId de identificação do boleto.
valueTotalLongValor total do boleto.
valuePayLongValor pago.
valueRefundedLongValor recusado.
barCodestringCódigo de barras.
dueDatestringData de vencimento.
externalReferencestringReferência externa de parceria.
statusstringStatus do boleto. Ex.: PENDING, PAID, CANCELED, ERROR, GENERATED, WAITING.
descriptionstringDescrição do boleto.
urlstringUrl com o pdf do boleto.
createdAtstringData de criação do boleto.
detailsObjectDetalhes do boleto gerado.

Details

VariávelTipoDescrição
barcodeNumberStringCódigo de barras.
walletStringCarteira.
ourNumberStringNosso número de identificação do boleto.
totalValueLongValor total do boleto.
issueDateStringData de emissão.
dueDateStringData de vencimento.
holderObjectObjeto contendo os dados do pagador.
beneficiaryObjectObjeto contendo os dados do recebedor/beneficiário.
accountObjectObjeto contendo os dados da conta bancária para recebimento do pagamento.

Holder

VariávelTipoDescrição
nameStringNome do pagador.
emailStringEmail.
legalDocumentStringDocumento (CPF ou CNPJ) do pagador.
addressObjectDados do endereço do pagador.

Address

VariávelTipoDescrição
stateStringEstado.
streetStringRua.
cityStringCidade.
postalCodeStringCódigo postal (CEP).
numberStringNúmero.

Beneficiary

VariávelTipoDescrição
establishmentNameStringNome do estabelecimento.
legalDocumentStringCNPJ do estabelecimento.

Account

VariávelTipoDescrição
agencyStringNúmero de agência.
numberStringNúmero da conta bancária.

❗️

Erros mapeados

Para visualizar os possíveis erros nesta API, acesse a Tabela de erros do pagamento web

Language
Click Try It! to start a request and see the response here!