Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

Use this file to discover all available pages before exploring further.

Automatic Pix is a recurring payment solution built on the Pix infrastructure. It allows businesses to collect recurring payments automatically after a one-time authorization by the payer. Unlike traditional direct debit, which requires bilateral agreements between companies and each bank, Automatic Pix works across the entire Pix ecosystem, making it accessible to any user with a bank account. Key Benefits:

For Your Business

  • Reduced Delinquency: Payments are collected automatically, mitigating forgetfulness.
  • Lower Costs: Generally cheaper than credit card fees and boleto issuance.
  • Higher Conversion: Accessible to customers who don’t have credit cards.
  • Immediate Settlement: Funds are available instantly, improving cash flow.

For Your Customers

  • Convenience: “Set it and forget it” experience for recurring bills.
  • Control: Easy management and cancellation via their banking app.
  • No Fees: Typically free for individual payers (Pessoa Física).
  • Safety: Built on the secure Pix infrastructure with established refund mechanisms.
Common Use Cases:
  • Utilities: Water, electricity, gas, and internet bills.
  • Subscriptions: Streaming services, newspapers, and software (SaaS).
  • Tuition: Schools, universities, and specialized courses.
  • Financial Services: Insurance premiums, condos, and loan repayments.
How it works (Authorization Journeys): The core of Automatic Pix is the authorization. The payer must grant permission for your business to debit their account periodically. We support the following journeys:
The receiver sends a dedicated authorization QR Code, and the payer subscribes to the recurring payment by scanning it — no immediate charge is made.
  1. QR Code Generation: The receiver generates and sends an Automatic Pix authorization QR Code to the payer.
  2. Scan: The payer scans the QR Code using their banking app.
  3. Subscription: The payer reviews the terms and confirms the recurring authorization via QR Code.
The receiver combines the first installment payment with the recurring authorization in a single QR Code, so the payer pays and subscribes in one step.
  1. QR Code Generation: The receiver generates a QR Code that includes both the first installment payment and the Automatic Pix authorization.
  2. Presentation: The receiver presents the QR Code with the immediate payment and subscription bundled together.
  3. Payment & Subscription: The payer scans the QR Code, pays the first installment, and subscribes to the recurring payment in a single action.
Creating an Automatic Pix Charge: Automatic Pix charges are created through the Create Authorization endpoint. To use Automatic Pix, include the automatic_pix object in the request body and set the type field according to the desired journey:
ValueJourneyDescription
optionalJourney 2Authorization only — no immediate payment is charged. The payer subscribes to the recurring payment via QR Code.
immediateJourney 3First payment + authorization — the payer pays the first installment and subscribes to the recurring payment in a single step.

​
Amount Types

When creating an authorization, you choose between two amount strategies by providing either amount or minimum_authorization_amount in the automatic_pix object.

​
Fixed amount

Provide amount to charge the same value every cycle. No PATCH is needed — the system automatically uses this value for every new schedule. 
"automatic_pix": {
  "amount": 5000,
  ...
}

​
Variable amount

Provide minimum_authorization_amount (and authorization_amount as the pre-authorized ceiling) to support cycles with different values. This is required if you plan to update the charge amount before each billing date. 
"automatic_pix": {
  "minimum_authorization_amount": 1000,
  "authorization_amount": 10000,
  ...
}
How each cycle’s amount is resolved: Each new schedule is created automatically using the authorization’s minimum_authorization_amount as the default value. If you want to charge a different amount for a specific cycle, use the Update Schedule endpoint to set a custom value before the schedule moves beyond Pending status.
ScenarioAmount charged
PATCH sent before the cycle’s due dateAmount from the PATCH
No PATCH sentminimum_authorization_amount
The PATCH on a schedule only affects that specific cycle. Future cycles always revert to minimum_authorization_amount regardless of what was charged in the previous cycle. To permanently change the default amount for all future cycles, use the Update Authorization endpoint instead.