Solicitação de emissão de boletos

post

https://api-mtls.sandbox.bankly.com.br/bankslip

Emita boletos de depósito (Deposit) e de cobrança (Levy).

stable scope: boleto.create

[block:callout] { "type": "warn", "title": "Importante", "body": "Recordamos que não é possível emitir boletos das 5h25 às 6h05. Em caso de emissão de boleto de cobrança, é obrigatório preencher as informações do pagador. Confira a documentação [Emissão de boleto](/v2/docs/emissao-de-boleto) para mais informações." } [/block]

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

alias

string | null

Nome para identificar o boleto externamente.

account

object

required

documentNumber

string | null

required

CPF ou CNPJ do emissor. Insira somente números.

amount

double

required

0 to 92233720368547760

Valor do boleto.

dueDate

date-time

required

Data de vencimento no formato yyyy-MM-dd.

type

string

enum

Caso este campo não seja especificado, nosso sistema gerará um boleto de depósito (Deposit) e irá desconsiderar as informações do pagador.

Allowed:

payer

object

Os dados do pagador são de preenchimento obrigatório em caso de emissão de boleto de cobrança (Levy).

minimumAmount

double

Valor mínimo do pagamento do boleto (específico e obrigatório para boletos de cartão de crédito). Importante: Este campo não deve ser preenchido em caso de boletos do tipo de Depósito (Deposit) e Cobrança (Levy).

closePayment

date-time

Data limite (yyyy-MM-dd) para o pagamento do boleto após o seu vencimento. Esse campo é de preenchimento obrigatório para a aplicação de juros e/ou multas. Em caso de juros, o valor informado nesse campo corresponde à data em que os juros param de incidir sobre o valor do boleto.

interest

object

Campo obrigatório somente para especificações da incidência de juros após o vencimento. Caso esse campo não seja preenchido, considera-se que não há incidência de juros no boleto.

fine

object

Campo obrigatório somente para especificações da incidência de multa após vencimento. Caso esse campo não seja preenchido, considera-se que não há incidência de multa no boleto.

discount

object

Objeto que contém informações sobre os descontos aplicados no boleto de cobrança (Levy). Este objeto somente é obrigatório para especificações da incidência de descontos para pagamento em até um dia antes da data de vencimento. Caso esse objeto não seja preenchido, considera-se que não há incidência de descontos no boleto.

Headers

api-version

string

required

Defaults to 2

Versão da API. Utilize este endpoint na versão 2.0.

Authorization

string

required

Token de autorização do tipo Bearer.

Responses

202A requisição foi aceita e está sendo processada.

400Há algum problema com a sua requisição.

401Acesso não autorizado.

403O acesso ao recurso foi negado pelo servidor.