Google Pay Component

This page explains how to add Google Pay to your existing Web Components integration.

When shoppers select Google Pay, the Component presents the Google Pay payment sheet where shoppers choose a card they want to use. If shoppers select a card that requires 3D Secure authentication, the Component also handles redirecting shoppers to another website to complete the verification.

Requirements

API reference

You do not need to send additional fields for Google Pay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:

• /sessions: This is the default with Components v5.0.0 or later.
• /payments: If you implemented an additional use case.

Component configuration

Step 1: Load the Google Pay API JavaScript library

We recommend that you preload the Google Pay API JavaScript library, by including the
following script in your checkout page:

<script src="https://pay.google.com/gp/p/js/pay.js"></script>

If you are loading the Drop-in inside an iframe element, add the allow attribute to the iframe to render Google Pay. For example:

<iframe allow="payment">
</iframe>

Step 2: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="googlepay-container"></div>

Step 3: Create an instance of the Component

Select which endpoint you are using:

Step 4: Mount the Component

Mount the Component only after checking that Google Pay is available to the shopper:

googlePayComponent
   .isAvailable()
   .then(() => {
       googlePayComponent.mount("#googlepay-container");
   })
   .catch(e => {
       //Google Pay is not available
   });

Optional configuration

You can configure the following:

• Merchant info
• Button options
• Payment data
• Card parameters
• Payment method support
• Transaction info
• Events

Merchant info

Configure the merchant name rendered in the payment sheet. See MerchantInfo for more details.

Button options

Configure the Google Pay button. See ButtonOptions for more details.

Payment data

Configure your payment requirements. See PaymentDataRequest for more details.

Card parameters

Configure accepted card types. See Card Parameters for more details.

Payment method support

Specify which payment methods are supported. See IsReadyToPayRequest for more details.

Transaction info

Configure the transaction details. See transaction information for more details.

Events

The following event handlers are supported for Google Pay.

Example

Recurring payments

To make recurring Google Pay payments, you first need to create a shopper token and then make subsequent recurring transactions with the token.
Refer to Tokenization for more information and detailed instructions.

Test and go live

To start testing Google Pay, log in to a Google account and create a Google Pay wallet.

There are two approaches to using this wallet for testing:

You can check the status of a Google Pay test payment in your Customer Area > Transactions > Payments, whether you used a card from the test card suite or or not. Remember that cards outside the test card suite are mapped to an Adyen test card of the same brand.

For more information, see Google Pay's test environment setup for Web.

Before you go live

1. Make sure that your API credential has the API Clientside Encryption Payments role. Check this in your live Customer Area or ask your Admin user to verify.
2. Go to your live Customer Area to configure your Google Merchant ID.
3. Complete the steps in the Google Pay API request production access.
4. Complete the steps in the Google Pay API deploy to production documentation for Web.

In the live environment, note that Google Pay will only be available if:

• The shopper is logged in to their Google account.
• The shopper has at least one valid payment method on their Google Pay account.

See also