Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB
Boleto Management

Issue Boleto

post/boletos

Request body

boletoConnectionIdstring uuid required

Primary identifier of the boleto connection

Example request

{
  "boleto": {
    "payer": {
      "taxNumber": "41.679.495/0001-00",
      "name": "NOME LEGAL EMPRESA"
    }
  }
}

Response

Boleto created successfully

idstring required

Primary identifier

amountnumber required

Boleto amount

status'OPEN' | 'PAID' | 'OVERDUE' | 'CANCELLED' | 'PROTESTED' required

Current status of the boleto.

  • OPEN: the boleto has been issued and is awaiting payment.
  • PAID: the boleto has been paid (see paidAt, amountPaid, paymentOrigin).
  • OVERDUE: the due date has passed and the boleto has not been paid.
  • CANCELLED: the boleto was canceled by the issuer.
  • PROTESTED: the boleto was sent to a protesto/credit-bureau process.
seuNumerostring required

Your identifier for this boleto

dueDatestring date-time required

Due date of the boleto

pixQrstring

PIX QR code for payment

digitableLinestring required

Boleto digitable line

nossoNumerostring

Bank's internal identifier for the boleto

barcodestring required

Boleto barcode

boletoConnectionIdstring uuid required

ID of the boleto connection used to create this boleto

createdAtstring date-time required

Date when the boleto was created

amountPaidnumber nullable

Amount that was paid for this boleto

paymentOrigin'PIX' | 'BOLETO' nullable

Origin of the payment when the boleto is paid

paidAtstring date-time

Date when the boleto was paid