Saltar al contenido principal
POST
Issue installment boletos

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Organization-Id
string

Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it.

Idempotency-Key
string
requerido

Client-supplied idempotency key, a UUID. Required: a request without it, or with a value that is not a UUID, is refused with 400 PBP-0012.

Cuerpo

application/json
firstDueDate
string<date>
requerido

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

Ejemplo:

"2030-01-15"

installments
integer<int64>
requerido

Number of installments.

Ejemplo:

2

intervalDays
integer<int64>
requerido

Days between consecutive installments.

Ejemplo:

30

midazAccountId
string
requerido

Midaz account the series settles into.

payer
object
requerido
type
string
requerido

Boleto type applied to every installment.

Ejemplo:

"TRADITIONAL"

discount
object
fine
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
Ejemplo:

"100.00"

Respuesta

Not returned: this operation is unavailable and answers 501 Not Implemented.

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