Skip to main content
cURL
Through this endpoint, the partner can register a boleto. The integrator’s API process registers the boleto with the appropriate agency. Before registering the boleto, the issuer must have a payee number linked to the account and a registered wallet. Wallet “1” is used for a simple boleto, which is the applicable status for this endpoint, and “9” for a CNAB (National Bank of Brazil). Payee registration must be performed at the /api/Payee endpoint, and the payee’s link to a wallet must be performed at the /api/Payee/Add Wallet endpoint.

Authorizations

Authorization
string
header
required

Copie 'Bearer ' + token

Headers

IdempotencyKey
string
required
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

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
Available options:
1,
2,
3
recorrencia
object | null

Response

Success

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