Schedulings and retries
With the recurrence authorized, each charge is a scheduling. The payer’s bank confirms it and debits on the date. Scheduling and requesting retries move money: they are financial operations and only accept an M2M credential with the pix.automatic scope. A panel user token gets 403.
Schedule a charge
Each cycle accepts one active scheduling; another one in the same cycle returns 409 automatic_pix_scheduling_conflict. A recurrence that is not authorized returns 409 automatic_pix_recurrence_not_authorized.
The response is 201 with the schedulingId. Then the webhooks follow:
pix.automatic.scheduling.confirmed, when the payer’s bank confirms. If it rejects,.rejected; if it does not answer in time,.failed.- On the date,
pix.automatic.settlement.completedandpix.in.completed, with the sameendToEndId. Do not add both up. - If the money does not arrive,
pix.automatic.settlement.failedwithsettlementIdandsettlementStatus(insufficient_balance,not_settledornot_settled_with_error).
Get and list
Live reads. The scheduling carries status, history, endToEndId and, when it exists, settlement with settlementId, status and settledAt. Retries appear in the same list with purpose: retry.
Postpone
Only while the scheduling is created, before it goes to the payer’s bank; after that the response is 409 automatic_pix_scheduling_conflict. The payer’s bank confirms the new date. Postponing is not a financial operation: the panel can do it too.
Retry
Applies to recurrences created with paymentRetry: true, after pix.automatic.settlement.failed.
The GET returns suggestedDates, remainingAttempts, maxRetryDates and windowEnd. A retry must fall after the original due date, within 7 calendar days and in the same cycle.
From 1 to 3 dates, among the suggested ones. Each becomes a scheduling with purpose: retry and follows the same webhook flow. A retry that is not allowed (no paymentRetry, already settled, an attempt in progress that day, or dates exhausted) returns 409 automatic_pix_retry_not_allowed.