Skip to main content
POST
Issue installment boletos

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
firstDueDate
string<date>
required

Due date of the first installment, YYYY-MM-DD.

Example:

"2030-01-15"

installments
integer<int64>
required

Number of installments.

Example:

2

intervalDays
integer<int64>
required

Days between consecutive installments.

Example:

30

midazAccountId
string
required

Midaz account the series settles into.

payer
object
required
type
string
required

Boleto type applied to every installment.

Example:

"TRADITIONAL"

discount
object
fine
object
guarantor
object
installmentAmounts
string[] | null

Per-installment amounts, at most 36. When supplied, its length must match installments.

Maximum array length: 36
Maximum string length: 32
interest
object
totalAmount
string

Series total as a decimal string. Optional: either this or installmentAmounts must be supplied.

Maximum string length: 32
Example:

"100.00"

Response

Created

boletos
object[] | null
required
installmentsCount
integer<int64>
required
seriesId
string
required
status
string
required
totalAmount
string
required