post https://sandbox.tbanks.com.br/bank-slip/issue
This endpoint creates a Bankslip.
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 desconto | Descrição |
---|---|
FIXED | Valor fixo descontado se o pagamento for realizado dentro do período de desconto. |
FIXED_DAILY | Valor fixo distribuído pelos dias disponíveis até o prazo do desconto, dependendo do emissor não é possível informar o prazo. |
PERCENTAGE | Valor percentual descontado se o pagamento for feito antes do período de desconto. |
PERCENTAGE_DAILY | Valor 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_DAILY | Valor 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 interesse | Descrição |
---|---|
"DAILY" | Juros diários na percentagem especificada |
"MONTHLY" | Juros mensais na percentagem especificada |
2.2. Tipos de multa
Tipo Fino | Descrição |
---|---|
"FIXED" | Juros diários no percentual especificado |
"PERCENTAGE" | Valor percentual |
Notas
- Os campos URL de notificação e Emails não são obrigatórios.
- 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.
- 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.
- 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
}