No momento, esta página não está disponível em português
Payment-method icon

Pix Drop-in integration

Add Pix to an existing Drop-in integration.

If you are using Android Drop-in v5.0.0 or later:

This payment method requires no additional configuration.

Follow the Drop-in integration guide.

When a shopper is ready to pay with Pix on your Android app:

  1. The shopper chooses to pay with Pix on your Android app.
  2. Your Android app shows a QR code or QR code data for the shopper to copy.
  3. The shopper opens their banking or wallet app participating in Pix.
  4. The shopper selects Pix, scans the QR code or pastes QR code data, and then confirms the payment.

Before you begin

To enable Pix on your Android app, choose which server-side flow your integration uses.

  1. Build a Drop-in integration.
  2. Add Pix in your Customer Area.

Create a session

No additional fields are required for Pix when you make the /sessions request. You can check if there are optional additional fields for Pix.

Show the payment result

1. Inform the shopper

From the onFinished function, you can get the resultCode to inform the shopper about the current payment status.

You can also get the result of the payment session on your backend server.

  1. Get the id from the /sessions response.
  2. Get sessionResult from the onFinished function.
  3. Make a GET /sessions/{id}?sessionResult={sessionResult} request including the id and sessionResult. For example:

    The response includes the result of the payment session (status). For example:

    Possible statuses:

    status Description
    completed The shopper completed the payment. This means that the payment was authorized.
    paymentPending The shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow.
    canceled The shopper canceled the payment.
    expired The session expired (default: 1 hour after session creation). Shoppers can no longer complete the payment with this sessionId.

The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Instead, check webhooks or the Transactions list in your Customer Area.

2. Update your order management system

You get the outcome of each payment asynchronously, in an AUTHORISATION webhook. Use the merchantReference from the webhook to match it to your order reference.
For a successful payment, the event contains success: true.

For an unsuccessful payment, you get success: false, and the reason field has details about why the payment was unsuccessful.


You can refund a payment within 90 days after the payment in the Customer Area or via 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.

See also