Documentação

English

Português
Español

English

Português
Español

Appearance

Automatic Charges ​

Access Prerequisites

  • Permission (module): processPaymentQueue
  • License/Feature: None specific.
  • Menu container: GENERAL → Charges group (route /automated-recurrences)

What it is / When to use ​

Automatic Charges are charge templates that recur perpetually by day of the month — with no end date. While the User Charge Registration screen defines a debit with a start and end date and generates installments month by month, here the operator defines a recurring template (description, currency, amount, and the day of charge) that remains valid indefinitely, until deleted.

Use it for ongoing fees and subscriptions that have no defined term. Each template stays active (is_active = true) and is applied on the configured day of each month.

Prerequisites ​

  • Permission: processPaymentQueue registered for the operator's role (dual permission — CPM enum in the backend + dynamic module in the DB).
  • License/Feature: None specific.
  • Dependencies on other screens: the debit is applied against the user's balance; the target customer must be APPROVED.

Step by step ​

  1. Go to Charges → Automatic Charges (route /automated-recurrences).
  2. The listing shows the registered templates with Description, Amount, Currency, and Day.
  3. Click Create new charge to open the modal.
  4. Fill in Description, Currency, Amount, and Day (1 to 31), then confirm with Save.
  5. To remove a template, click the trash icon on that row.

Fields (registration modal) ​

FieldWhat it isRequired?System/backend effect
DescriptionText that identifies the charge and appears on the statementYesSaves description in automated_recurrently_charges (FMS).
CurrencySymbol of the charge currency (e.g.: BRL, token)YesSaves unit_of_money_requested. As with other charges, BRL routes the debit through the digital account; other symbols through the crypto wallet.
AmountAmount to debit each cycleYes (> 0)Saves amount_requested (numeric column). Treated as BigNumber during processing.
DayDay of the month on which the charge is appliedYes (integer 1–31)Saves day. Defines the recurring monthly due date. The modal validates that the value is an integer between 1 and 31.

The is_active field is automatically set to true on save — there is no toggle on the screen. To "disable" a charge, delete the template.

Actions and modals ​

  • Create new charge: opens the AutomatedRecurrencyModalComponent modal. Save is only enabled when description, currency, amount (> 0), and day (1–31) are all valid.
  • Save: sends a POST /v1/automated-recurrently/create request. On success, the list is reloaded.
  • Delete (trash): calls POST /v1/automated-recurrently/delete with the recurrencyId. After confirmation the page is reloaded.

Business rules / Cautions ​

Attention

  • Automatic Charges have no end date — they remain active until deleted. Review the list periodically to avoid undue debits.
  • The Currency determines the rail (digital account for BRL, wallet for token). Double-check the symbol.
  • The Day must exist in the month; short months may require care when choosing 29/30/31.
  • Financial values: treated as BigNumber — no rounding.
  • Idempotency: the application of each cycle follows the idempotent pattern of FinLib — E00021 ("already processed") is a success, not an error.
  • APPROVED status: the target user must be approved for the debit to be executed.