Through the endpoints presented in this section, the integrator partner can schedule pix-type transactions. This feature allows you to create, list, and cancel schedules for a specific account.
- The scheduling date follows Brasília time (BRT or UTC/GMT -03:00).
- Transactions will be attempted starting at 8 AM BRT.
- Transactions that fail due to insufficient balance will be retried in 1 hour, with a limit of 3 attempts.
- For key, static_qr_code, and dynamic_qr_code transactions, the Pix key will be re-verified before the transaction is completed to ensure that the destination account has not changed. If any discrepancy is detected, the schedule will be rejected (rejected).
- A webhook will be sent to the integrator partner informing the success or rejection of a schedule.
- It's not possible to schedule an instant dynamic_qr_code.
- Scheduled transfers consume your Pix transaction limit.
| Enumerator | Description |
|---|
| scheduled | Scheduled transaction |
| sent | Schedule completed and successfully sent. Final status. |
| rejected | Schedule rejected during creation or execution. Final status. |
| cancelled | Schedule canceled by customer request. Final status. |
| pending_2fa_approval | Pending two-factor authentication approval. |
| pending_creation | Schedule in the process of creation (Transitional state for batch scheduling). |
| waiting_batch_approval | Schedule created and linked to a batch awaiting two-factor authentication approval. |
On the scheduled day, after verifying the consistency of the target account, the pix transaction will be attempted. At this point, a pix_transfer is generated and added to the schedule_transfers list. A maximum of 3 pix transactions will be attempted.
| Field | Type | Description | Characters |
|---|
pix_transfer_key | uuidv4 | Unique key for identifying the Pix transfer in the QI system. | 36 |
end_to_end_id * | string | Idempotency key for a Pix transaction within the SPI (Instant Payment System). | 32 |
pix_transfer_status | string | Transaction status. | Enumerators pix_transfer_status |
created_at | string | Timestamp of when the transaction was created. | 20 |
| Enumerator | Description |
|---|
| sent | Transaction successfully sent. Final status. |
| rejected | Transaction rejected during execution. Final status. |
| pending | Transaction pending conclusion. Transitional state. |