Boleto

Na API de Banking Gateway da Stone o boleto é considerado um tipo de transação, por isso seus campos correspondem ao do objeto transaction. Para saber mais sobre cada campo consulte a guia de conceito de transação.

Nesta página vamos falar sobre as particularidades do Boleto.

Tipos de Boleto

Nossa API, possui 3 tipos de boletos (payment_slip_type): Depósito, Proposta e Cobrança. Eles apresentam regras de funcionamento diferentes.

Tipo	Descrição	`payment_slip_type`
Depósito	Boleto criado para depositar dinheiro na conta em que ele foi emitido.	`deposit`
Proposta	Boleto emitido antes da prestação de um serviço ou da entrega de um produto, como uma oferta, sendo o seu pagamento considerado o aceite da negociação. Também pode ser usado como proposta de um contrato e como convite para uma associação. Ele é facultativo, ou seja, o seu não pagamento não dará causa a protesto ou cobrança por parte do emissor.	`proposal`
Cobrança	Boleto para cobrar por um serviço prestado, por um produto entregue ou para o pagamento de uma dívida de uma obrigação legal. Possibilita a inclusão de descontos, juros e multa. Esse é o único tipo de boleto com valor legal.	`bill_of_exchange`

Status

O estado que os três tipos de boleto podem ter, é definido pelo Status.

Status	Descrição
`pending`	Indica que o boleto foi gerado e não foi pago, está com o pagamento pendente.
`approved`	Indica que o boleto foi pago.
`denied`	Indica que o boleto foi cancelado pelo emissor ou que ele atingiu a data limite (limit_date) sem ser pago.

Veja no fluxograma abaixo como funciona a mudança de status:

Data de Vencimento x Data Limite

Outra particularidade do Boleto é a diferença entre os tipos de data que podem influenciar no valor do boleto gerado.

Tipo	Campo	Descrição
Data de Vencimento	`due_data`	Determina quando vai parar de ter desconto/começar juros, multa,... Data de vencimento do boleto bancário. O boleto ainda pode ser pago após atingir essa data.
Data Limite	`limit_date`	Data limite para pagamento do boleto bancário. Após essa data o boleto não pode ser mais pago. Os boletos que forem pagos após a data limite serão devolvidos.

Regras por tipo de Boleto

Além disso, o boleto possui regras de negócio específicas que precisam ser respeitadas, elas estão listadas abaixo de acordo com cada tipo de boleto disponível em BaaS.

	Depósito	Proposta	Cobrança
Obrigação Legal	❌ Não possui	❌ Não possui	✅ Possui
Valor	Pode ter um valor mínimo R$20,00 e máximo de R$9.999,99.	Pode ter um valor mínimo R$20,00 e máximo de R$50.000,00	Pode ter um valor mínimo R$20,00 e máximo de R$50.000,00
Data de vencimento	Precisa ser igual ou maior que o dia atual. Ela pode ser até 365 dias depois da data de emissão.	Precisa ser igual ou maior que o dia atual. Ela pode ser até 365 dias depois da data de emissão.	Precisa ser igual ou maior que o dia atual e menor que ao `limit_date`.
Data limite	A data limite é igual a de vencimento (`due_date`). Caso não seja fornecida uma `limit_date`, será usada a data de vencimento. Caso seja um dia não útil, o pagamento poderá ser feito até o próximo dia útil. Os boletos que forem pagos após a data limite serão devolvidos.	A data limite é igual a de vencimento (`due_date`). Caso não seja fornecida uma `limit_date`, será usada a data de vencimento. Caso seja um dia não útil, o pagamento poderá ser feito até o próximo dia útil. Os boletos que forem pagos após a data limite serão devolvidos.	A data limite pode ser igual ou maior que a data de vencimento (`due_date`). Ela pode ser até 365 dias depois da data de emissão. Caso não seja fornecida uma `limit_date`, será usada a data de vencimento. Caso seja um dia não útil, o pagamento poderá ser feito até o próximo dia útil. Os boletos que forem pagos após a data limite serão devolvidos.
Desconto	❌ Não suporta	❌ Não suporta	✅ Desconto deve ser maior que 0.0 e até 0.9. O desconto se aplica caso o pagamento seja feito até a data informada. A data informada deve ser menor do que a data de vencimento do boleto e maior que sua data de emissão. Campo não obrigatório, só preencher se for aplicar desconto.
Juros	❌ Não suporta	❌ Não suporta	✅ O valor do juros deve ser maior que 0.0 e até 1.0, calculado como resultado da seguinte fórmula: `value`\_ 10 ^ exponent (ex: 0,02 \_10^2=. O valor calculado é referente ao juro mensal, porém é aplicado por dia, levando em conta o valor proporcional (ex: 1% ao mês, seria 0,033% ao dia). O juros não precisa começar após a data de vencimento, é possível escolher a data de inicio da cobrança no object `interest` Campo não obrigatório, só preencher se for aplicar juros.
Juros	❌ Não suporta	❌ Não suporta	✅ O valor da multa deve ser maior que 0.0 e até 2.0, como resultado da seguinte fórmula: (value \* 10 ^ exponent). Campo não obrigatório, só preencher se for aplicar multa.

Metadata

As informações contidas no campo de metadata de boletos estão aqui.