Skip to main content
POST
Initiate a payment

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
digitableLine
string
required

Bankslip or utilities digitable line, digits only.

Example:

"00190500954014481606906809350314337370000000100"

midazAccountId
string
required

Midaz account the payment settles from.

payer
object
required

Who pays this slip. Required by the provider contract.

description
string

Free-text description carried on the payment.

payeeName
string

Recipient name. Optional: may be omitted, and an empty value is treated exactly like omitting it.

payeeTaxId
string

Recipient CPF or CNPJ, digits only. Optional: may be omitted, and an empty value is treated exactly like omitting it.

Response

Created

amount
string
required
createdAt
string
required
digitableLine
string
required
id
string
required
providerId
string
required
status
string
required
type
string
required
dueDate
string