Payment-method icon

Pix Drop-in integration

Add Pix to an existing Drop-in integration.

On this page, you can find additional configuration for adding Pix to your Drop-in integration.

Before you begin

This page assumes you have already:

Collect additional parameters in your payment form

Collect the following details from the shopper:

Pass the collected data to your server because you will need to submit both Name and CPF/CNPJ in the /payments request. This information will be shown to the shopper to help identify the payment.

API reference

Select which endpoint you're integrating:

This is the default with Drop-in v5.0.0 or later.

Parameter Required Description
amount -white_check_mark- The final price of the purchase.
shopperName Shopper's first name and last name.
socialSecurityNumber The shopper's CPF or CNPJ number. This will be shown to the shopper on the Pix payment form.
shopperStatement Free-text field that will be shown to the shopper. Maximum length: 140 characters. The name of the purchased item. Maximum 50 characters.
lineItems.amountIncludingTax The price of the purchased item including tax. Maximum 200 characters.

Drop-in configuration

There is no Pix specific configuration for Drop-in.


You can refund a payment within 90 days after the payment in the Customer Area or using an API.

Test and go live

Pix is an asynchronous payment method. In the test environment, you can simulate a Pix payment by promoting the pending payment to a sale.

  1. Log in to your test Customer Area.
  2. Go to Transactions > Offers.
  3. Select the PSP reference of the pending Pix payment.
  4. Select the Promote this offer to a sale button.

Pix payments that have been paid (including test offers that you manually promoted to sale) are under Transactions > Payments.

Test the reconciliation process by promoting test payments from offer to sale in your test Customer Area.

Before you can accept live Pix payments, you need to submit a request for Pix in your live Customer Area.