Skip to main content

Documentation Index

Fetch the complete documentation index at: https://support.wepayments.com.br/llms.txt

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

WEpayments offers a complete Payin solution for companies operating in Brazil or in cross-border operations. With it, your website, app, or platform can issue and manage payments using the three main payment methods in the country: Pix, Boleto Bancário, and Credit Card. All operations can be done via API (for full integration) or directly through the WEpayments Dashboard. For international companies, the solution includes FX (foreign exchange) and settlement in any foreign currency – all in one platform.

1. Pix

Pix is the Central Bank of Brazil’s (BCB) instant payment system. Its main advantage is settlement in seconds, 24 hours a day, 7 days a week – including weekends and holidays.

How does Payin via Pix work at WEpayments?

Receiving via Pix is done through a dynamic QR Code (which can be scanned with a mobile phone camera) or a “copy and paste” link. Both are generated at checkout.

Information required to generate a Pix charge

When creating a Pix charge, you must provide:
  • Payer’s document (CPF)
  • Payer’s email
  • Full address (ZIP code, street, number, complement, neighborhood, city, state)
  • Amount (minimum of R$ 0.01)
  • Due date
  • Additional instructions (optional)
  • Interest and fine (if applicable)
  • Discounts (if applicable)
  • Final beneficiary (name, CNPJ, and customer service channel)

Pix status in the Dashboard

StatusMeaning
CreatedPix generated, awaiting payment
CanceledNot paid by the due date
PaidPayment confirmed
CreditedAmount available for withdrawal (added to Available Balance)

Liquidity

Pix settlement is immediate. Once payment is confirmed, the amount appears in your Available Balance – ready for settlement.

Automatic Pix

Automatic Pix is a new feature of the Pix system that enables automatic recurring charges, the customer authorizes once, and future payments are debited automatically. For payers (end customers):
  • Convenience: no need to remember or repeat payment every month.
  • Control: manage limits and cancellations directly through their bank’s app.
For recipients (your business):
  • Reduced delinquency.
  • Lower operational costs (no boletos or cards).
  • Reach: over 160 million Pix users.
Security is the same as traditional Pix, with support for the Special Return Mechanism (MED) in case of issues.

2. Boleto Bancário (Bank Slip)

Boleto is a traditional and widely used payment method in Brazil. The customer receives a barcode and pays at banks, lottery outlets, or via internet banking.

Information required to generate a boleto

The fields are similar to Pix, with some key differences:
  • Payer’s document (CPF)
  • Payer’s email
  • Full address
  • Amount (minimum of R$ 5.00)
  • Due date
  • Additional instructions (optional)
  • Interest, fine, and discounts (if applicable)
  • Final beneficiary

Boleto status in the Dashboard

StatusMeaning
CreatedBoleto generated, awaiting payment
CanceledNot paid by the due date
PaidPayment confirmed, but not yet credited
CreditedAmount available for withdrawal
💡 Total Balance vs. Available Balance:
  • Total Balance = boletos with “Paid” + “Credited” status (revenue forecast).
  • Available Balance = only boletos with “Credited” status (actual amount ready for withdrawal).

Boleto liquidity

Settlement occurs on D+1 (one business day) after payment. It can take up to 4 days until the payer makes the payment.

3. Credit Card

Available for all companies, with specific features for international (cross-border) companies.

Accepted brands

  • Visa
  • Mastercard
  • Elo
  • Hipercard
  • Diners Club
  • American Express

Installments

You can split payments into up to 12 installments, with a minimum installment value of R$ 5.00.

Liquidity models

WEpayments offers two settlement models:
ModelHow it worksAvailable for
Early settlementAmount credited on D+0 (same day) for domestic clients or D+1 for international clientsSubject to contract
Flow settlementAmount credited on D+30 (domestic) or D+31 (international) per installmentStandard

Credit card status in the Dashboard

StatusMeaning
CreatedAwaiting payment action
Awaiting approvalPending confirmation from the card issuer
ConfirmedPayment confirmed by the issuer
CreditedAvailable for withdrawal
CanceledExpired or canceled by the merchant
RejectedIncorrect data, fraud rejection, or bank rejection

Information required to issue a credit card charge

From the payer:
  • CPF
  • Email
  • Full address
From the charge:
  • Amount
  • Due date
  • Success URL
  • Failure URL
  • Logo URL (for checkout customization)
  • Statement descriptor (name that appears on the invoice – up to 13 characters)
From the product:
  • Name, category ID, ID, quantity, unit price, description
From the final beneficiary:
  • Name, CNPJ, and customer service channel

Information the customer must fill in at checkout

  • Card number (16 digits)
  • Expiration date (MM/YY)
  • Security code (CVV)
  • Cardholder name (exactly as on the card)
  • Number of installments
  • Cardholder’s CPF
  • Privacy policy acceptance (LGPD)

Quick comparison table

FeaturePixBoletoCredit Card
LiquidityImmediate (seconds)D+1 (business day)D+0 to D+31 (depends on model)
Availability24/7Business hours24/7
Minimum amountR$ 0.01R$ 5.00R$ 5.00 per installment
InstallmentsNo (except Recurring Pix)NoYes, up to 12x
Best forInstant payments, low-value transactions, urgencyCustomers without cards, scheduled paymentsHigher-value sales, installments, cross-border operations

Frequently Asked Questions (FAQ)

1. Can I use all payment methods at the same time?
Yes. Integrate once via API and offer Pix, boleto, and credit card in your checkout.
2. Do I need a separate contract for each method?
The standard WEpayments contract covers all three. Early settlement models or Recurring Pix may require an addendum.
3. How do I track charge statuses?
Via the Dashboard (Charges menu or Reports > Balances). The API also returns real-time statuses.
4. What happens if a customer pays a boleto after the due date?
It depends on your interest and fine configuration. The boleto may be accepted with additional fees or simply canceled.
5. For international companies, which method is best?
Credit card with early settlement (D+1) + FX. Pix also works, but the customer needs a Brazilian bank account.