Skip to main content
POST
Issue a single boleto

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

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.

Cuerpo

application/json
amount
string
requerido

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

Maximum string length: 32
Ejemplo:

"100.00"

dueDate
string<date>
requerido

Due date, YYYY-MM-DD.

Ejemplo:

"2030-01-15"

midazAccountId
string
requerido

Midaz account the boleto settles into.

payer
object
requerido
type
string
requerido

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

Ejemplo:

"TRADITIONAL"

discount
object
fine
object
guarantor
object
instructions
string
interest
object

Respuesta

Created

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