Emitir novo boleto

This endpoint creates a Bankslip.

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

1. Descontos
É possível adicionar tipos de desconto a um boleto para pagamento até determinado prazo.

Detalhe importante: A estrutura de desconto (array) deverá ser adicionada na solicitação de registro do boleto. Para alguns bancos emissores o número de descontos é limitado, consulte disponibilidade.

1.1. Tipos de desconto

Tipo de descontoDescrição
FIXEDValor fixo descontado se o pagamento for realizado dentro do período de desconto.
FIXED_DAILYValor fixo distribuído pelos dias disponíveis até o prazo do desconto, dependendo do emissor não é possível informar o prazo.
PERCENTAGEValor percentual descontado se o pagamento for feito antes do período de desconto.
PERCENTAGE_DAILYValor percentual distribuído pelos dias corridos disponíveis até a data limite de desconto, dependendo do emissor não é possível informar a data limite.
BUSINESS_PERCENTAGE_DAILYValor percentual distribuído pelos dias úteis disponíveis caso o pagamento seja realizado dentro do prazo, dependendo do emissor não é possível informar o prazo.

2. Juros e Multa
Você pode adicionar juros e multa para pagamentos efetuados após o vencimento.

Detalhe importante: Caso os objetos não constem na solicitação, serão utilizadas as informações relativas à multa e juros cadastrados na conta.

2.1. Tipos de Juros

Tipo de interesseDescrição
"DAILY"Juros diários na percentagem especificada
"MONTHLY"Juros mensais na percentagem especificada

2.2. Tipos de multa

Tipo FinoDescrição
"FIXED"Juros diários no percentual especificado
"PERCENTAGE"Valor percentual

Notas

  1. Os campos URL de notificação e Emails não são obrigatórios.
  2. Caso haja pelo menos 1 (um) e-mail preenchido no campo E-mails, o pagador receberá um link para acessar o Boleto através dele e poderá então imprimir o documento.
  3. Caso o campo URL de notificação seja preenchido, após o pagamento ou baixa do banco, será enviada uma notificação informando sobre a alteração do status do boleto.
  4. Caso o campo split esteja preenchido o boleto será dividido entre as contas que compõe o mesmo, o campo slip não é obrigatório, mas uma vez preenchido o boleto irá ser dividido entre as contas.

Exemplo de requisição

{
  "amount": 0.00,
  "dueDate": "2024-12-09",
  "receiptMessage": "receiptMessage_cf7389d2a93c",
  "yourNumber": 0,
  "urlNotification": "urlNotification_efe62ba55bf6",
  "urlNotificationPartner": "urlNotificationPartner_2b7d85c95428",
  "payer": {
    "name": "name_94c35a4b4eab",
    "documentNumber": "documentNumber_39f7485dc112",
    "street": "street_c750a29de8a6",
    "district": "district_b9e4079f298e",
    "city": "city_7bf030a5b613",
    "state": "AC",
    "zipCode": "zipCode_5f2480b25838",
    "tax": 0.00
  },
  "emails": [
    "emails_b7c9d2895a54"
  ],
  "splits": [
    {
      "amount": 0.00,
      "documentNumber": "documentNumber_8b2ff6a1effe",
      "accountIdentifier": "1cc5b91f-920f-4411-a130-4bea0205d860",
      "tax": 0.00
    }
  ],
  "interest": {
    "interestType": "DAILY",
    "value": 0.0,
    "date": "2024-12-09"
  },
  "fine": {
    "fineType": "FIXED",
    "value": 0.0,
    "date": "2024-12-09"
  },
  "daysToWriteOff": 0,
  "discounts": [
    {
      "discountType": "FIXED",
      "value": 0.0,
      "date": "2024-12-09"
    }
  ],
  "email": "email_0bd24efd2f33",
  "message": {
    "message1": "message1_019af966b77e",
    "message2": "message2_46157cf4794b",
    "message3": "message3_2dc7f574aad4",
    "message4": "message4_dcc8b4afa114"
  },
  "hybridBill": false
}
Body Params
string
required
Defaults to 2023-08-20

Data de vencimento do boleto

double
required
Defaults to 357.98

Valor do boleto

string
required
Defaults to This is your rent Bankslip.

Informações para serem exibidas no campo instruções para o pagador.

string
required
Defaults to https://example-webhook.com

URL para notificação de pagamento do boleto

payer
object
required

Dados do pagador

emails
array of strings
required
Defaults to [email protected]

Lista de emails para envio do boleto emitido

emails*
discounts
array of objects

Dados de desconto do boleto

discounts
interest
object

Dados de juros de boleto

fine
object

Dados de multa de boleto

int32
Defaults to 100008993

Número único para identificação do boleto

split
array of objects

Lista de contas para divisão de boletos.

split
Headers
string
required
Defaults to 366b4352-05dc-4210-a4f2-c1dc8e3db140

Identificador da conta emissora do boleto

Responses

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