Emitir um novo boleto. (v3 - com faixas de desconto)

post

https://example.com/pj/forintegration/cobranca/v3/boletos/simplificado

Body Params

Criar do boleto simplificado

Payload de emissão de boleto simplificado, com suporte a beneficiário final e faixas de desconto escalonado (até 3 faixas).

seuNumero

string | null

Identificador do boleto definido pelo próprio emissor, usado para reconhecimento no seu sistema (ex.: número da venda ou nota fiscal). Aceita apenas letras e números.

cliente

object

required

Dados do pagador (sacado) do boleto.

beneficiarioFinal

object

Quem de fato recebe o valor do boleto quando é diferente do cedente.

sacadorAvalista

object

Sacador avalista do boleto.

vencimento

date-time

required

Data de vencimento do boleto.

valor

double

required

Valor monetário em reais.

canal

string | null

Apelido para identificação do beneficiário.

multa

object

Configuração de multa e juros aplicados após o vencimento. Multa máxima: 20%. Juros máximos: 20% ao mês.

desconto

object

Configuração de desconto por pagamento antecipado.

mensagem

object

Mensagem informativa impressa no boleto, dividida em até 4 linhas (linha1 a linha4) com até 80 caracteres cada. Utilizada para orientar o caixa ou o pagador.

aceite

boolean | null

Indicador de reconhecimento da obrigação de pagamento pelo pagador.

especie

string | null

Classificação do documento que origina o boleto. Valores válidos: 0 = Duplicata Mercantil, 6 = Duplicata de Serviço, 9 = Outros. Padrão: Outros.

dataLimitePagamento

date-time | null

Data limite até a qual o boleto pode ser pago após o vencimento. O prazo configurável é de 1 a 90 dias após o vencimento.

carteira

int32

enum

Carteira de cobrança à qual o boleto pertence. Código 21 = Carteira simples. Código 41 = Carteira vinculada (boleto pode ser dado como garantia de crédito, sujeito a qualificação pelo time de crédito).

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

201Created

400Bad Request