Skip to main content

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​

StatusMeaning
PENDINGCreated; waiting for the first payment and the payer authorization
AUTHORIZEDFirst payment settled and payer PSP approved the recurrence — schedules can run
COMPLETEDAll cycles finished (reserved; not yet emitted)
CANCELLEDCancelled by you or by the payer (terminal)
EXPIREDPayer never completed the journey before expiresAt (terminal)
FAILEDAuthorization rejected by the payer PSP, or first payment refunded while pending (terminal)

Recurrence — statusDetailed​

Detailed statusPairs withMeaning
AWAITING_FIRST_PAYMENTPENDINGQR issued, first Pix not settled yet
FIRST_PAYMENT_SUCCESSPENDINGFirst Pix settled; waiting for the payer PSP confirmation
VALIDATION_SUCCEEDEDAUTHORIZEDPayer PSP approved the recurrence
VALIDATION_REJECTED_PAYERFAILEDPayer PSP rejected the recurrence
CANCELLED / EXPIRED / FAILEDsameMirrors 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​

StatusMeaning
CREATEDCharge registered, not yet sent to the payer PSP
PENDINGCharge instruction sent; awaiting the payer PSP response
SCHEDULEDPayer PSP accepted; awaiting settlement on the due date
SUCCESSSettled — funds received
CANCELLEDCancelled by you or by the payer PSP (terminal)
FAILEDRejected, send failure or payer response timeout (terminal)

Schedule — statusDetailed​

Detailed statusPairs withMeaning
PENDING_SENDCREATEDWaiting for dispatch to the payer PSP
AWAITING_PAYER_RESPONSEPENDINGInstruction delivered; response due within 2 h
SEND_FAILEDPENDING/FAILEDDispatch failed — retried with backoff; terminal after attempts are exhausted (rejectionCode=PAYER_RESPONSE_TIMEOUT when the payer PSP never responded)
AWAITING_SETTLEMENTSCHEDULEDAccepted; waiting for the due date
REJECTED_BY_PAYERFAILEDPayer PSP rejected the charge (rejectionCode/rejectionReason set)
REJECTED_BY_RECEIVERFAILEDSettlement rejected on the receiving end
SETTLEDSUCCESSFunds received (endToEndId, settledAt set)
CANCELLEDCANCELLEDCancelled
SENDING, SETTLEMENT_FAILED—Reserved for future use

Schedule purpose​

PurposeMeaning
AGNDRegular scheduled cycle charge
NTAGPost-due retry (≤ 3 dates, within 7 calendar days after the due date)
RIFLSame-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.