Emitir boleto

POST https://sandbox.staging.justa.com.vc/payment-provider/api/bill-issuance

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

Resposta da requisição

Variável	Tipo	Descrição
id	string	Id de identificação do boleto.
valueTotal	Long	Valor total do boleto.
valuePay	Long	Valor pago.
valueRefunded	Long	Valor cancelado.
barCode	string	Código de barras.
dueDate	string	Data de vencimento.
externalReference	string	Identificador único definido pelo parceiro (Referência externa).
status	string	Status do boleto. Ex.: PENDING, PAID, CANCELED, ERROR, GENERATED, WAITING.
description	string	Descrição do boleto.
url	string	URL com o PDF do boleto.
createdAt	string	Data de criação do boleto.
details	Object	Detalhes do boleto gerado.

Details

Variável	Tipo	Descrição
barcodeNumber	String	Código de barras do boleto.
wallet	String	Carteira de emissão do boleto.
ourNumber	String	Nosso número de identificação da Justa do boleto (Pode ser repetido).
totalValue	Long	Valor total do boleto em centavos.
issueDate	String	Data de emissão do boleto.
dueDate	String	Data de vencimento do boleto.
holder	Object	Objeto contendo os dados do pagador.
beneficiary	Object	Objeto contendo os dados do beneficiário final.
account	Object	Objeto contendo os dados da conta bancária de recebimento do boleto.

Holder

Variável	Tipo	Descrição
name	String	Nome do pagador/sacado do boleto.
email	String	E-mail do pagador/sacado do boleto.
legalDocument	String	CPF ou CNPJ do pagador do boleto.
address	Object	Dados do endereço do pagador do boleto.

Address

Variável	Tipo	Descrição
state	String	UF do endereço.
street	String	Logradouro do endeeço.
city	String	Cidade do endereço.
postalCode	String	Código postal (CEP) do endereço.
number	String	Nú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ável	Tipo	Descrição
establishmentName	String	Nome do beneficiário.
legalDocument	String	CPF ou CNPJ do beneficiário.

Account

Variável	Tipo	Descrição
agency	String	Agência da conta bancária.
number	String	Nú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