API Reference

Emitir e registro do boleto na CIP.

post
https://example.com/pj/forintegration/cobranca/v2/boletos/simplificado
Body Params

Criar do boleto simplificado

string | null

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

beneficiarioFinal
object

Dono do produto e/ou serviço oferecido.

cliente
object
required

ClienteDto para criação de Boleto Simplificado V2

sacadorAvalista
object

Sacador/Avalista não são obrigatórios, mas uma vez que se informe o CPF/CNPJ do mesmo, é preciso que informe os demais dados do Avalista.

date-time
required

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

double
required

Valor da cobrança original

string | null

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

multa
object

Multas e juros do boleto

desconto
object

DescontoDto

mensagem
object

MensagemDto

boolean | null

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

string | null

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
date-time | null

Data limite para pagamento

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
Updated about 1 year ago