Campos

Boleto

Chave Descrição Tipo
account_id Identificador da conta do beneficiário. String
amount Valor do boleto bancário gerado, em centavos de reais. Integer
barcode Código de barras. String
beneficiary Objeto com os dados do beneficiário. Veja os campos desse object abaixo. Object
created_at Data e hora em que o boleto bancário foi gerado. Nesse caso nunca será null. Formato ISO8601 "YYYY-MM-DDThh:mm:ssZ". String
created_by Identificador único do usuário ou aplicação que criou a transação, no formato user:UUID4 ou application:UUID4respectivamente. Nesse caso nunca será null. String
customer Objeto com os dados do cliente que será informa como pagador no ato de registro do boleto. Veja os campos desse object abaixo. Object
discount Objeto com os dados referentes ao desconto. Veja os campos desse object abaixo. Object
expiration_date Data de vencimento do boleto bancário. Mesmo depois dessa data expirar o pagamento ainda pode ser feito.
Formato "YYYY-MM-DD".
String
fee Projeção da taxa que seria cobrada do beneficiário no ato de recebimento do pagamento caso o recebimento fosse agora. É atualizada com a taxa cobrada quando receber o pagamento. Integer
fee_metadata Objeto que identifica detalhes sobre a aplicação da taxa. Veja os campos desse object abaixo. Object
fine Objeto com os dados referentes a multa. Veja os campos desse object abaixo. Object
id Identificador único do boleto bancário, no formato UUID4. String
interest Objeto com os dados referentes aos juros. Veja os campos desse object abaixo. Object
invoice_type Tipo de boleto bancário. Valores suportados: proposal, deposit e bill_of_exchange. String
issuance_date Data da emissão de boleto bancário. Formato "YYYY-MM-DD". String
limit_date Data limite para pagamento do boleto bancário. Sempre igual ou maior a data de vencimento. Formato "YYYY-MM-DD". String
our_number Número que identifica unicamente um boleto para uma conta frente a outras instituições. String
receiver Objeto com os dados do sacador avalista. Veja os campos desse object abaixo. Object
registered_at Data e hora de registro do boleto bancário. Formato ISO8601 "YYYY-MM-DDThh:mm:ssZ". String
settled_at Data e hora em que o dinheiro do pagamento do boleto é depositado na conta do beneficiário. Formato ISO8601
"YYYY-MM-DDThh:mm:ssZ".
String
status Status atual do boleto bancário, podendo ser um dentre os status à seguir: CREATED, REGISTERED, SETTLED, CANCELLED ou EXPIRED. String
writable_line Código de barras traduzido em números. String

Campos do objeto beneficiary
Chave Descrição Tipo
account_code Número da conta bancária. String
branch_code Número da agência da conta. String
document Número do documento do beneficiário sem pontos. String
document_type Tipo do documento do beneficiário. Pode ser ‘cpf’ ou ‘cnpj’. String
legal_name É o nome que identifica o beneficiário para fins legais, administrativos e outros fins oficiais. String
trade_name Nome fantasia do beneficiário. String

Campos do objeto discount
Chave Descrição Tipo
date Data até a qual o desconto deve ser aplicado.
Formato ISO8601 "YYYY-MM-DD".
String
value Valor percentual (%) do desconto que será aplicado ao boleto. O valor do deve ser maior que 0.0 e até 90.0.
Formato decimal. Ex: “20.0”.
String

Campos do objeto fee_metadata
Chave Descrição Tipo
billing_exemption_participant Indica se o usuário possui alguma condição especial vigente. Boolean
fee Projeção da taxa que seria cobrada no ato de recebimento do pagamento caso o recebimento fosse agora. Integer
max_free Indica o número total de boletos emitidos que podem ser liquidados sem que haja custos por mês. Integer
original_fee Indica a taxa original do item para a essa conta. Integer
remaining_free Indica o número restante de boletos gerados que podem ser pagos sem que haja custos no periódo. Integer

Campos do objeto fine
Chave Descrição Tipo
date Data que define o dia a partir do qual a multa deve ser aplicada ao boleto.
Formato ISO8601 "YYYY-MM-DD".
String
value Valor percentual (%) da multa que será aplicada ao boleto. O valor do deve ser maior que 0.0 e até 2.0.
Formato decimal. Ex: “2.0”.
String

Campos do objeto interest
Chave Descrição Tipo
date Data que define o dia a partir do qual os juros passam a ser aplicados ao boleto.
Formato ISO8601 "YYYY-MM-DD".
String
value Valor percentual (%) dos juros que serão aplicados ao boleto. O valor do deve ser maior que 0.0 e até 2.0.
Formato decimal. Ex: “2.0”.
String

Campos do objeto customer
Chave Descrição Tipo
document Número do documento do pagador sem pontos. String
document_type Tipo do documento do pagador. Pode ser CPF ou CNPJ. String
legal_name É o nome que identifica o pagador para fins legais, administrativos e outros fins oficiais. String
trade_name Nome fantasia do pagador. String

Campos do objeto receiver
Chave Descrição Tipo
document Número do documento do sacador avalista. String
legal_name É o nome que identifica o sacado avalista para fins legais, administrativos e outros fins oficiais. String

Última modificação: 20.10.2020