Checkout

Integration type API Reference
Payment Form

Coverage

CountriesBrazil (BR)
CurrenciesBrazilian Real (BRL)
Min amount0.50 BRL
Max amountBank dependent

Capabilities

RecurringYes
RefundYes
Partial refundsYes
Multiple partial refundsYes
ChargebackNo

Principle of operation


  1. Selection at checkout
    Customer selects Pix at checkout.
  2. Payment initiation
    Customer is redirected to a hosted page to choose their bank.
  3. Authentication and authorization
    Customer selects a bank and confirms the authorization purpose and limits.
  4. Payment confirmation
    Customer is redirected to their bank app to authenticate and approve the payment.
  5. Payment approval
    Customer approves the payment and is redirected back to the hosted page.
  6. Merchant notification
    Merchant receives a notification Webhook confirming the payment status.

Init payment API request must be sent with the pix parameter to the payment_method field or integrates the APM buttons flow in the payment form for SmartPix.

SmartPix payment page example SmartPix payment page example SmartPix payment page example SmartPix payment page example SmartPix payment page example SmartPix payment page example

For SmartPix refunds, a connector can process the refund using the same Pix information the customer provided for the original payment.

However, this is only possible on the same day the Pix payment is confirmed.

If this time frame has passed, the connector emails the customer to request their bank information or Pix key to issue the refund.

  • Pix key can be a CPF/CNPJ (Tax ID, Entity ID), an email address, a phone number, or a randomly generated key consisting of up to 32 characters.
Pix payments are real-time transfers that expire after 1 hour, and any unpaid transactions are automatically cancelled.

Handle SmartPix errors

Specific errors may occur when a SmartPix payment attempt fails.

  • 2.01 Invalid data
    The decline may be related to an invalid or incorrectly formatted payer identification document (CPF). Retry the transaction and verify that the document number is correct and matches the required format.