Skip to main content

Introduction

Pix Automático is a payment solution developed by the Central Bank of Brazil to automate Merchant Initiated Transactions. The process follows a structured sequence:

  1. Subscription Creation & Enrollment: Once a subscription is created, the user must provide an "Enrollment" authorization via their banking app.
  2. Billing Cycle Generation: Upon successful authorization, the Billing Cycle is created based on the subscription's defined periodicity.

Crucially, the Billing Cycle is generated regardless of the merchant_initiation setting (true or false). Even if the Merchant is responsible for the scheduling and payment request, the Billing Cycle remains the core entity responsible for:

  • Controlling the subscription status.
  • Verifying payments.
  • Dispatching necessary notifications and webhooks back to the Merchant.

Core Rules & Constraints​

  • Provider Consistency: To ensure security, all transactions for a specific subscription including enrollment, the initial charge, and all subsequent retries must be processed through the same provider.
  • Mandatory Scheduling: PIX Automático requires payments to be scheduled in advance. The Engine handles this automatically during the "Scheduling Window" for subscriptions.
    • Minimum Setup Time: Due to these mandatory scheduling windows, the dueDate (start date) for a new subscription must be set to at least 3 days after the current date (Today + 3 days).

Capabilities & Constraints Matrix (PIX Automático)​

The following table outlines the logical availability of features for the PIX Automático scheme based on the chosen initiation model.

Feature / ScenarioEngine-Driven (false)Merchant-Driven (true)Notes
Fixed Amount✅ Available✅ AvailableStandard recurring model.
Variable Amount✅ Available✅ AvailableRequires merchant_initiation: true as the Merchant must provide the specific value per cycle.
Local Currency (Order = Destination)✅ Available✅ AvailableE.g., Charging BRL to a Brazilian payer.
Cross-Currency (FX) (Order ≠ Destination)✅ Available✅ AvailableE.g., Defining a price in USD. The Engine automatically handles conversion to BRL at the time of execution.
Merchant Initiation & Variable Amounts

For merchant_initiation: false, variable amounts can be set for each billing cycle using the override amount feature.

Lifecycle Windows​

The engine manages the billing cycle based on rigid time windows defined by regulation. All times are relative to the cycle's dueDate.

Window PhaseStart TimeEnd TimeDescription
SchedulingdueDate - 8 daysdueDate - 3 daysCritical. The engine (or Merchant) sends the scheduling request. If missed, the payment cannot be processed.
Charge (Payer's Bank)dueDate + 00:00dueDate + 06:00The actual debit attempt occurs on the due date.
Charge 2 (Intra-day)dueDate + 18:00dueDate + 23:00Secondary execution window on the same day.
Retry WindowdueDate + 1 daydueDate + 7 daysIf previous attempts fail, subsequent retries occur here (up to 3 attempts).

Supported Configurations​

For PIX Automático, the Subscription entity supports the following specific parameters:

  • Amount Types:
    • FIXED: Supported.
    • VARIABLE: Supported.
Override Amount Best Practices

The choice between FIXED and VARIABLE affects payer trust, conversion, and your operational overhead. See Override Amount Best Practices for scenario guidance — including how FX conversion impacts FIXED subscriptions in foreign currency and when to use each model.

  • Retry Policies:
    • 001: NOT_ALLOW (No retries).
    • 002: ALLOW_3_RETRIES_7_DAYS (Up to 3 retries within the 7-day window).

Operational Flows​

Enrollment Only​

Used when the customer authorizes future payments without an immediate charge.

  1. Creation: Status is PENDING until user authorization.
  2. Cycle Management: The Engine waits until the date enters the Scheduling Window (dueDate - 8 days) to create the cycle and schedule the charge.

Payment on Enrollment​

Used when the customer pays for the first cycle and authorizes the subscription simultaneously.

  1. Creation: Subscription and first Billing Cycle created immediately.
  2. Processing: The first cycle bypasses the Scheduling Window and moves directly to the CHARGE phase.
  3. Outcome: If successful, status becomes ACTIVE. If failed, REJECTED (no retries allowed for enrollment).

Cycle Calculation & Edge Cases​

The dueDate is the primary anchor for all calculations.

  • Month-End Logic: Automatically adjusts dates for shorter months (e.g., Jan 31st results in a Feb 28th/29th due date).
  • The forceWorkDay Flag:
    • If true, weekend/holiday due dates move to the next business day.

Merchant-Initiated Orchestration​

Specifics for merchant_initiation: true with PIX Automático.

When operating in this mode, your system acts as the initiation engine. You must:

  1. Send payment/schedule requests to the designated API endpoint.
  2. Strictly adhere to the Lifecycle Windows defined above (e.g., you cannot schedule a payment after Day - 3).
  3. Listen to webhooks to update the Billing Cycle and Subscription status in your local records.