v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Emissão de boleto

Emissão de boleto com faixas de desconto

post/pj/forintegration/cobranca/v3/boletos/simplificado

Request body

seuNumerostring nullable

Campo para definição de número para o boleto à escolha do cliente, aceita apenas números e letras. Não é obrigatório! Em caso de não enviar, geramos uma numeração automática para este campo em nossa camada do BS2

vencimentostring date-time required

Data de vencimento do boleto, deverá ser maior ou igual que a data atual. Exemplo: 2019-03-28

valornumber double required

Valor da cobrança original

canalstring nullable

Caso o boleto possua beneficiário final, informar neste campo.

aceiteboolean nullable

Campo para definição de aceite do boleto para casos de protesto do título

especiestring nullable

Código para identificar o tipo de boleto de pagamento de cobrança. Valores válidos:

  • "0" = Duplicata Mercantil
  • "6" = Duplicata de Serviço
  • "9" = Outros
dataLimitePagamentostring date-time nullable

Data limite para pagamento

carteira11 | 21 | 31 | 41

11-Desconto, 21-CobrancaSimples, 31-CobrancaCaucionada, 41-CobrancaVinculada

Response

Success

seuNumerostring required

Seu número (identificador do boleto). Exemplo: 25962

clienteIdstring uuid required

Código do cliente. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

vencimentostring date-time required

Data de vencimento do boleto, deverá ser maior ou igual que a data atual. Exemplo: 2019-03-28

valornumber double required

Valor o boleto, deverá ser maior que ZERO. Exemplo: 99.25

canalstring nullable

Apelido para identificação do Beneficiário. Exemplo: Bs2 Hub

aceiteboolean nullable

Aceite

especiestring nullable

Código para identificar o tipo de boleto de pagamento de cobrança. Valores válidos:

  • "0" = Duplicata Mercantil
  • "6" = Duplicata de Serviço
  • "9" = Outros
idstring uuid

Código do boleto. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

status1 | 2 | 3 | 4

1-Aberto, 2-Vencido, 3-Cancelado, 4-Pago

nossoNumerointeger nullable

Nosso Número. Exemplo: 10008600128

codigoDeBarrastring nullable

Código de barra do boleto. Exemplo: 21095787100000000000010000000000000000000000

linhaDigitavelstring nullable

Linha Digitavel do boleto. Exemplo: 21090010070000000000000860000000000000000000000