Skip to main content
POST
Pay and Confirm a Scanned Pix Automático Recurrence

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id
string
required

Unique identifier of the Midaz Ledger Account (UUID format).

X-Idempotency
string
required

Idempotency key

Body

application/json
amount
string
required

Amount is the debit amount in BRL (format 0.00). Required. Format and positivity — and, for QR_CODE initiations, the QR fixed-amount match — are validated when the payment is processed.

Example:

"29.90"

idRec
string
required
Maximum string length: 64
Example:

"RR0000000000000000001"

initiationId
string
required
Example:

"550e8400-e29b-41d4-a716-446655440010"

description
string

Description is the optional transfer remittance (≤140 characters; no HTML). Content rules are enforced when the payment is processed.

Example:

"Payment for services"

receiverMaxAmount
string
Example:

"500.00"

Response

OK

authorizationRequest
object
cashoutId
string
Example:

"550e8400-e29b-41d4-a716-446655440010"

cashoutStatus
enum<string>
Available options:
CREATED,
PENDING,
PROCESSING,
COMPLETED
Example:

"PROCESSING"