Pix Automático — overview
Pix Automático is the recurring charge of the Pix scheme. The payer authorizes once in their bank app, and your account schedules each charge with no new confirmation. The CorpX account is always the receiver.
The automatic_pix feature starts disabled for every tenant. While it is off, every route under /v1/accounts/{accountId}/pix/automatic returns 403 feature_disabled. CorpX enables the feature in the admin panel after the contract. Disabling it later does not cancel an authorized recurrence.
Credential scope: pix.automatic. Reads also accept read. In the panel, viewing requires pix_automatic.view and issuing or postponing requires pix_automatic.manage.
How a recurrence starts
Details in Recurrences and composite QR.
Lifecycle
Every relevant change emits a pix.automatic.* webhook and a pix_automatic.* event in the timeline, anchored on the recurrenceId.
Payloads in Webhooks.
Two identifiers
recurrenceIdis the UUID the API returns on creation. It is the recurrence id in this API, in webhooks and in the timeline.recurrenceIdentifier(RR…orRN…) is the Pix scheme id. It appears once the scheme assigns it and is what the payer sees in their bank.
Every route with {recurrenceId} accepts both. RR…/RN… is only recognized after the recurrence went through this API or a webhook of the account.
Next steps
- Recurrences and composite QR: create, list and get.
- Schedulings and retries: charge, postpone and retry.