Google Pay Component

On this page, you can find additional configuration for adding Google Pay to your 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.

Before you begin

Before starting your Google Pay integration:

1. Build a Components integration.
2. Follow the setup steps in the Google Pay documentation.
3. Add Google Pay in your Customer Area.

API reference

You don't 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 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>

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're integrating:

/sessions /payments

/sessions /payments

This is the default with Components v5.0.0 or later.

There's no additional configuration you need to include for Google Pay.

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const googlePayComponent = checkout.create('googlepay');

If you implemented an additional use case.

Parameter name	Required	Description
amount.value		The value of the payment, in minor units.
amount.currency		The currency code of the payment.
countryCode		The two-letter country code of your merchant account.
environment		Set to PRODUCTION when you're ready to accept live payments. The default value is TEST.

The following example shows how to configure Components:

Google Pay configuration

const googlePayConfiguration = {
    amount: {
        value: 1000,
        currency: "EUR"
    },
    countryCode: "NL",
    //Set this to PRODUCTION when you're ready to accept live payments
    environment: "TEST"
};

https://docs.adyen.com/payment-methods/google-pay/web-component#google-pay-configuration

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component. Pass the configuration object if you created one:

const googlePayComponent = checkout.create('googlepay', googlePayConfiguration);

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 merchant name that appears on the Google Pay payment sheet.
• The Google Pay button appearance.
• Your payment requirements.
• The card types that you accept.
• The payment methods that you support.
• Event handlers to use.

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.

Events

The following event handlers are supported for Google Pay.

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 test Google Pay, log in to a Google account and create a Google Pay wallet with the details of a real card, not a test card. When you make a test payment, the card number is automatically mapped to our test card number starting with 4111, so the real card is not charged.

You can check the status of a Google Pay test payment in your Customer Area > Transactions > Payments.

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

Before you go live

1. Make sure 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 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