Skip to main content
POST
Issue a single boleto

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Organization-Id
string

Tenant organization ID. Accepted but ignored: the tenant is determined by the credentials you authenticate with, so sending this header, or sending a different value in it, changes nothing.

Idempotency-Key
string

Client-supplied idempotency key. Required in practice even though the schema marks it optional: a request that omits this header is refused with 400 PBP-0012.

Body

application/json
amount
string
required

Amount as a decimal string, at most two decimal places.

Maximum string length: 32
Example:

"100.00"

dueDate
string<date>
required

Due date, YYYY-MM-DD.

Example:

"2030-01-15"

midazAccountId
string
required

Midaz account the boleto settles into.

payer
object
required
type
string
required

Boleto type. Only TRADITIONAL is supported in V1. HYBRID (BolePix) and QR_CODE are refused with 422 PBP-0006.

Example:

"TRADITIONAL"

discount
object
fine
object
guarantor
object
instructions
string
interest
object

Response

Created

amount
string
required
createdAt
string
required
dueDate
string
required
id
string
required
providerId
string
required
status
string
required
type
string
required
barcode
string
digitableLine
string
discount
object
fine
object
instructions
string
interest
object
qrCode
string