BSbs2
Emitir boleto

Emitir um novo boleto.

post/pj/forintegration/cobranca/v2/boletos/simplificado

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

seuNumerostring nullable

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.

vencimentostring date-time required

Data de vencimento do boleto.

valornumber double required

Valor monetário em reais.

canalstring nullable

Apelido para identificação do beneficiário.

aceiteboolean nullable

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

especiestring nullable

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

dataLimitePagamentostring date-time nullable

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.

carteirainteger

Código da carteira de cobrança. Valores: 21 (Carteira simples) ou 41 (Carteira vinculada).

Response

Created

seuNumerostring required

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.

clienteIdstring uuid required

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

vencimentostring date-time required

Data de vencimento do boleto.

valornumber double required

Valor monetário em reais.

canalstring nullable

Apelido para identificação do beneficiário.

aceiteboolean nullable

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

especiestring nullable

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

idstring uuid

Identificador único no formato GUID. Exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

statusinteger

Status atual do boleto no ciclo de vida.

nossoNumerointeger nullable

Identificador do boleto gerado pelo banco.

codigoDeBarrastring nullable

Código de barras do boleto. Exemplo: 21895787100000000000010000000000000000000000.

linhaDigitavelstring nullable

Linha digitável do boleto. Exemplo: 21090010070000000000000860000000000000000000000.

Changes

No recorded changes to this operation across all 1 revision of this API.