{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identdNossoNum": "<string>",
  "numCodBarras": "<string>",
  "numLinhaDigtvl": "<string>",
  "numDocTit": "<string>"
}
Por meio deste endpoint, o parceiro pode efetuar o registro de um boleto. O processo da API por parte do integrador, faz com que o boleto seja registrado junto ao órgão responsável. Antes de efetuar o registro do boleto é necessário que o emissor tenha um número de cedente vinculado a conta e uma carteira registrada, sendo carteira “1” para boleto simples que é a situação que se aplica neste endpoint e “9” para CNAB. O registro do cedente deve ser realizado no endpoint /api/Cedente e o vínculo do cedente a uma carteira deve ser realizado no endpoint /api/Cedente/AdicionarCarteira.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
beneficiario
object

Objeto detalhado da Conta Bancária do Beneficiário.

​
dadosBoleto
object
​
pagador
object
​
pagadores
object
​
sacadorAvalista
object
​
juros
object
​
multa
object
​
desconto
object
​
descontos
object[] | null
​
instrucoesBeneficiario
string[] | null

Intruções do Beneficiário para o Pagador. Limitado a 4 ocorrências de, no máximo, 100 caracteres cada uma.

​
numeroCarteira
integer

Número da carteira de cobrança utilizada para o registro do boleto.

​
tipoRegistro
enum<integer>

1 = Online; 2 = Offline; 3 = CNAB

Available options:
1,
2,
3
​
recorrencia
object
​
cobrancaCompartilhada
object[] | null

Response

200 - application/json

Success

​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigoBoleto
string<uuid>

Código UUID identificador do boleto registrado.

​
identdNossoNum
string | null

Número de Controle do Cedente para identificar o Título.

​
numCodBarras
string | null

Código de barras do Boleto de Pagamento.

​
numLinhaDigtvl
string | null

Linha digitável do Boleto de Pagamento.

​
numDocTit
string | null

Número do Documento do Título utilizado pelo Cedente.