Initiate a Pix Transfer
Initiate a Pix Transfer
Use this endpoint to start a Pix cash-out by creating an initiation record. This endpoint retrieves and validates destination information without moving funds.
Notes:
- This endpoint supports three initiation types: MANUAL (full account data), KEY (using a Pix key), and QR_CODE (using a QR code).
- For KEY initiation, the plugin queries the DICT service to retrieve destination account information.
- For QR_CODE initiation, the plugin decodes the QR code and queries the DICT service to retrieve destination account information.
- The initiation does not move funds - it only validates and prepares the transfer.
- After successful initiation, use the Process endpoint to complete the transfer.
POST
Initiate a Pix Transfer
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Unique identifier of the Midaz Ledger Account (UUID format).
Body
application/json
Initiation type.
Available options:
MANUAL, KEY, QR_CODE Example:
"KEY"
Transfer amount.
Example:
"100.00"
Pix key (required for KEY type).
Example:
QR Code EMV payload (required for QR_CODE type).
Transfer description.
Example:
"Payment for services"