Pular para o conteúdo principal
cURL
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.

Autorizações

Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Cabeçalhos

IdempotencyKey
string
obrigatório
IgnoraHandshake
boolean
padrão:true
obrigatório

(somente em homologação)

Corpo

beneficiario
object | null
dadosBoleto
object | null
pagador
object | null
sacadorAvalista
object | null
juros
object | null
multa
object | null
desconto
object | null
descontos
object[] | null
instrucoesBeneficiario
string[] | null
numeroCarteira
integer<int32>
tipoRegistro
enum<integer> | null
Opções disponíveis:
1,
2,
3
recorrencia
object | null

Resposta

Success

sucesso
boolean
mensagem
string | null
codigoBoleto
string<uuid>
identdNossoNum
string | null
numCodBarras
string | null
numLinhaDigtvl
string | null
numDocTit
string | null