Pix Automático
API: POST /v1/pix/automatic/recurrences, GET /v1/pix/automatic/recurrences/{id}, GET /v1/pix/automatic/schedules/{id}
Two resources carry status: the recurrence (the authorization) and each schedule (a cycle charge). Both expose a summary status and a granular statusDetailed.
Recurrence — status
| Status | Meaning |
|---|---|
PENDING | Created; waiting for the first payment and the payer authorization |
AUTHORIZED | First payment settled and payer PSP approved the recurrence — schedules can run |
COMPLETED | All cycles finished (reserved; not yet emitted) |
CANCELLED | Cancelled by you or by the payer (terminal) |
EXPIRED | Payer never completed the journey before expiresAt (terminal) |
FAILED | Authorization rejected by the payer PSP, or first payment refunded while pending (terminal) |
Recurrence — statusDetailed
| Detailed status | Pairs with | Meaning |
|---|---|---|
AWAITING_FIRST_PAYMENT | PENDING | QR issued, first Pix not settled yet |
FIRST_PAYMENT_SUCCESS | PENDING | First Pix settled; waiting for the payer PSP confirmation |
VALIDATION_SUCCEEDED | AUTHORIZED | Payer PSP approved the recurrence |
VALIDATION_REJECTED_PAYER | FAILED | Payer PSP rejected the recurrence |
CANCELLED / EXPIRED / FAILED | same | Mirrors the summary status |
AWAITING_PAYER_PSP_RESPONSE, VALIDATION_REJECTED_RECEIVER | — | Reserved for future use |
firstPaymentStatus tracks the first Pix independently: PENDING → SETTLED (or REFUNDED, which fails a pending recurrence / cancels an authorized one).
cancellationReason values: ACCOUNT_CLOSED, RECEIVER_COMPANY_CLOSED, RECEIVER_REQUEST_ERROR, FRAUD_SUSPECTED, DUPLICATE_AUTHORIZATION, RECEIVER_REQUESTED, PAIN_009_TIMEOUT (receiver-settable) and PAYER_REQUESTED (set when the payer cancels in their app).
Schedule — status
| Status | Meaning |
|---|---|
CREATED | Charge registered, not yet sent to the payer PSP |
PENDING | Charge instruction sent; awaiting the payer PSP response |
SCHEDULED | Payer PSP accepted; awaiting settlement on the due date |
SUCCESS | Settled — funds received |
CANCELLED | Cancelled by you or by the payer PSP (terminal) |
FAILED | Rejected, send failure or payer response timeout (terminal) |
Schedule — statusDetailed
| Detailed status | Pairs with | Meaning |
|---|---|---|
PENDING_SEND | CREATED | Waiting for dispatch to the payer PSP |
AWAITING_PAYER_RESPONSE | PENDING | Instruction delivered; response due within 2 h |
SEND_FAILED | PENDING/FAILED | Dispatch failed — retried with backoff; terminal after attempts are exhausted (rejectionCode=PAYER_RESPONSE_TIMEOUT when the payer PSP never responded) |
AWAITING_SETTLEMENT | SCHEDULED | Accepted; waiting for the due date |
REJECTED_BY_PAYER | FAILED | Payer PSP rejected the charge (rejectionCode/rejectionReason set) |
REJECTED_BY_RECEIVER | FAILED | Settlement rejected on the receiving end |
SETTLED | SUCCESS | Funds received (endToEndId, settledAt set) |
CANCELLED | CANCELLED | Cancelled |
SENDING, SETTLEMENT_FAILED | — | Reserved for future use |
Schedule purpose
| Purpose | Meaning |
|---|---|
AGND | Regular scheduled cycle charge |
NTAG | Post-due retry (≤ 3 dates, within 7 calendar days after the due date) |
RIFL | Same-day reissue after the payer PSP cancels with reason FAIL — keeps the amount and reconciliationId, links back via retryOfScheduleId |
When a schedule ends FAILED or CANCELLED, check rejectionCode and rejectionReason. The attempts[] array carries the full dispatch trail.
Webhook events for Pix Automático: see Webhooks.
See also Pix Automático errors.