Emitir boleto

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Resposta da requisição

VariávelTipoDescrição
idstringId de identificação do boleto.
valueTotalLongValor total do boleto.
valuePayLongValor pago.
valueRefundedLongValor cancelado.
barCodestringCódigo de barras.
dueDatestringData de vencimento.
externalReferencestringIdentificador único definido pelo parceiro (Referência externa).
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 do boleto.
walletStringCarteira de emissão do boleto.
ourNumberStringNosso número de identificação da Justa do boleto (Pode ser repetido).
totalValueLongValor total do boleto em centavos.
issueDateStringData de emissão do boleto.
dueDateStringData de vencimento do boleto.
holderObjectObjeto contendo os dados do pagador.
beneficiaryObjectObjeto contendo os dados do beneficiário final.
accountObjectObjeto contendo os dados da conta bancária de recebimento do boleto.

Holder

VariávelTipoDescrição
nameStringNome do pagador/sacado do boleto.
emailStringE-mail do pagador/sacado do boleto.
legalDocumentStringCPF ou CNPJ do pagador do boleto.
addressObjectDados do endereço do pagador do boleto.

Address

VariávelTipoDescrição
stateStringUF do endereço.
streetStringLogradouro do endeeço.
cityStringCidade do endereço.
postalCodeStringCódigo postal (CEP) do endereço.
numberStringNúmero do endereço.

🚧

Alguns parâmetros que exigem cuidado:

  • O campo bairro não pode conter caracteres especiais.
  • Fazemos uma validação do CEP com o endereço informado, então esteja atento com essas informações.

Beneficiary

VariávelTipoDescrição
establishmentNameStringNome do beneficiário.
legalDocumentStringCPF ou CNPJ do beneficiário.

Account

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

❗️

Erros mapeados

Para visualizar os possíveis erros nesta API, acesse a Tabela de erros do emissão de boletos

Body Params
string
required
Defaults to 1de098b3-3e43-47ab-aa7d-a0aa0a0a0a00

Identificador único do boleto para o seu sistema.

int64
required
Defaults to 12300

Valor do boleto em centavos. Ex.: 500 equivalem a R$5,00.

date
required
Defaults to {dueDate}

Data de expiração do boleto. Necessário que seja uma data maior do que hoje. No formato YYYY-MM-DD.

string
required
Defaults to Teste de boleto

Descrição do boleto em texto aberto de até 255 caracteres.

payee
object
required

Dados do cliente emissor do boleto.

payer
object
required

Dados do cliente pagador.

boolean

Campo para ativar ou desativar o envio de email com aviso da data de vencimento. Se o campo não for enviado, será true e o email será enviado.

Headers
string
required
Defaults to {IntegratorId}

ID que identifica o integrador e é repassado pelo técnico responsável por sua integração

string
required
Defaults to {Token}

Token único gerado para o estabelecimento no momento de onboarding.

string
required
Defaults to Bearer {access_token}

Autenticação do tipo Bearer a ser enviada. O atributo {access_token} é gerado na requisição para o servidor de autenticação da Justa, como já explicitado na seção de autenticação deste documento.

string
Defaults to application/json

Tipo do corpo da requisição a ser enviado.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json