Pix Drop-in integration

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.

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.

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

Show Pix in your payment form

Include Pix in the list of available payment methods.

1. Specify in your /paymentMethods request:

• countryCode: BR.
• amount.currency: BRL.

2. The response contains paymentMethod.type: pix.

Make a payment

When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod.

1. Pass paymentComponentData.paymentMethod to your server.

2. From your server, make a /payments request, specifying:

Parameter	Required	Description
paymentMethod		The state.data.paymentMethod from the onSubmit event from your front end.
amount		The amount information for the transaction (in minor units).
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		The text to be shown on the shopper's bank statement. By default this contains the message: $merchantName - Este pagamento PIX para $merchantName é processado por Adyen. If you provide any value, keep the length under 60 characters because this will be appended to the default message.
sessionValidity		The expiration date of the Pix payment. The default value is 1 hour (Checkout API v71 or earlier) or 24 hours (Checkout API v72 or later), the maximum value is 5 days, in ISO 8601 format. For example: 2020-07-18T15:42:40.428+01:00
lineItems.id		The name of the purchased item. Maximum 50 characters.
lineItems.amountIncludingTax		The price of the purchased item including tax. Maximum 200 characters.

The /payments response contains:

• action: Object containing information about the payment.

3. The action object of the response automatically indicates to the InstantPaymentComponent to call the QR code action.

Submit additional payment data

After the shopper completes the payment, make a POST /payments/details request from your server, providing:

• details: The actionComponentData.details object from the Drop-inComponent

You receive a response containing:

• resultCode: Use this to show the payment result to your shopper.

• pspReference: Our unique identifier for the transaction.

Show the payment result

1. Inform the shopper

Use the resultCode from the /payments/details response to present the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a webhook.

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.