Recurrence Status

What it is: RecurrentPaymentStatus (also referenced as recurrentPaymentStatusEnum) is the field that indicates the current state of a recurring payment in Checkout Cielo.

• Where it appears:
  • In the response of the recurrence query (GET), in the RecurrentPaymentStatus field.
  • In the content of transaction completion notifications, as the recurrent_status field.
• What it represents: represents the phase of the recurrence lifecycle — from the initial state (before the first payment) to the final termination states (by user action, upon reaching the end date, or due to technical failures).

Recurrence status values

How to use

Monitor the RecurrentPaymentStatus field to track the recurrence lifecycle:

1. Direct query: use the GET /RecurrentPayment/{id} endpoint with the PagadorRecurrentPaymentId to get the current recurrence status.
2. Notifications: the recurrent_status field is returned in the content of transaction completion notifications.
3. Automatic termination: when the status is 2 (Denied), 5 (Expired card), or 6 (Maximum attempts), the system has deactivated the recurrence and it will no longer run. Reactivation is not possible.
4. Manual deactivation: use the DELETE /RecurrentPayment/Deactivate/{pagadorRecurrentPaymentId} endpoint to terminate an active recurrence (status 1). This action is irreversible.
5. Update: while active (status 1), you can update the amount, interval, end date, billing day, and next payment date via PUT /RecurrentPayment/Update.

Important: detailed query, update, and deactivation operations are only available after the first transaction is paid, when the PagadorRecurrentPaymentId is generated.

Interpreting the values

• Active / in progress

  • 1 — Active: the recurrence is running normally. Charges occur according to the configured interval (monthly, bimonthly, quarterly, semiannual, or annual) and can be managed via API.

• Transitional / awaiting

  • 0 — Pending: initial state after recurrence creation, before the first payment is processed. The PagadorRecurrentPaymentId is not yet available.
  • 7 — Awaiting reconciliation: intermediate state during the financial reconciliation process.

• Automatically terminated by the system

  • 2 — Denied: the issuer refused the charge and the system deactivated the recurrence.
  • 5 — Deactivated due to expired card: the linked card reached its expiration date and the recurrence was terminated.
  • 6 — Deactivated due to maximum number of attempts: charge attempt limit reached without success. The recurrence is permanently terminated.

• Intentionally terminated

  • 3 — Deactivated by user.
  • 4 — Finalized: the recurrence reached the configured EndDate and was terminated at the end of the contract.

Important notes

• Once deactivated (status 2, 3, 4, 5, or 6), the recurrence cannot be reactivated. To resume periodic charges, you must create a new recurrence.
• The PagadorRecurrentPaymentId is generated only upon payment of the first transaction. Before that (status 0), update and deactivation operations are not available.
• Recurrence in Checkout Cielo is exclusive to credit cards.
• Available billing intervals: Monthly (1 month), Bimonthly (2 months), Quarterly (3 months), Semiannual (6 months), and Annual (12 months).