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
digitableLinestring required
nossoNumerostring
Bank's internal identifier for the boleto
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