Integrate Google Pay with JS SDK for direct merchants

Google Pay integration

Google Pay is a mobile payment and digital wallet service provided by Alphabet Inc.

Buyers can use Google Pay on PayPal to make payments on the web using a web browser.

Sellers can use PayPal with Google Pay to sell physical goods, such as clothes and electronics, and intangible professional services, such as concerts or gym memberships.

Supported countries and currencies

Google Pay supports payments in 36 countries and 22 currencies:

• Countries: Australia, Austria, Belgium, Bulgaria, Canada, China, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hong Kong, Hungary, Ireland, Italy, Japan, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Netherlands, Norway, Poland, Portugal, Romania, Singapore, Slovakia, Slovenia, Spain, Sweden, United States, United Kingdom
• Currencies: AUD, BRL, CAD, CHF, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PHP, PLN, SEK, SGD, THB, TWD, USD

How it works

1. The Google Pay button shows up on your website when a customer uses a web browser.
2. The buyer selects the Google Pay button on your website.
3. Your website shows the buyer a payment sheet.
4. The buyer can choose a different shipping address and payment method.
5. The buyer authorizes the payment.

1. Set up your sandbox account to accept Google Pay

Before you can accept Google Pay on your website, verify that your sandbox business account supports Google Pay.

Direct merchants can use the PayPal Developer Dashboard to set up their sandbox accounts to accept Google Pay.

1. Log into the PayPal Developer Dashboard and go to your sandbox account.
2. Go to Apps & Credentials.
3. Make sure you are in the PayPal sandbox environment by selecting Sandbox at the top.
4. Select or create an app.
5. Scroll down to Features and check if Google Pay is enabled. If Google Pay isn't enabled, select the Google Pay checkbox and select the "Save" link to enable Google Pay.

If you created a sandbox business account through sandbox.paypal.com, and the Google Pay status for the account shows as disabled, complete the sandbox onboarding steps to enable Google Pay.

This screenshot shows the Google Pay sandbox settings in the mobile and digital payments section of the PayPal Developer Dashboard. This only applies to direct merchant integrations:

2. Getting started in your testing environment

Before you develop your Google Pay on the Web integration, you need to complete Get started to set up your PayPal account, client ID, and sandbox emails for testing.

3. Integrate Google Pay checkout

Follow this integration process to add Google Pay as a checkout option, customize the payment experience, and process payments.

Call the Orders API

To accept Google Pay directly on your website, create API endpoints on your server that communicate with the PayPal Orders V2 API. These endpoints can create an order, authorize payment, and capture payment for an order.

Server-side example (Node.js)

This code demonstrates using the PayPal Orders V2 API to add routes to an Express server for creating orders and capturing payments.

Find the complete sample code in the GitHub repo.

1import * as PayPal from "./paypal-api.js";
2
3/* Create Order route Handler */
4app.post("/api/orders", async (req, res) => {
5  const order = await PayPal.createOrder();
6  res.json(order);
7});
8
9/* Capture Order route Handler */
10app.post("/api/orders/:orderID/capture", async (req, res) => {
11  const {
12    orderID
13  } = req.params;
14  const captureData = await PayPal.capturePayment(orderID);
15  res.json(captureData);
16});

4. Set up your Google Pay button

You need to integrate with the Google Pay JavaScript SDK and PayPal JavaScript SDK to add Google Pay to your site.

Integrate PayPal JavaScript SDK

Use this script to integrate with the PayPal JavaScript SDK:

1<script src="https://www.paypal.com/sdk/js?client-id=YOUR_CLIENT_ID&currency=USD&buyer-country=US&merchant-id=SUB_MERCHANT_ID&components=googlepay"></script>

Include googlepay in the components list.

Integrate Google JavaScript SDK

Use this script to integrate with the Google Pay JavaScript SDK:

1<script async src="https://pay.google.com/gp/p/js/pay.js" onload="onGooglePayLoaded()"></script>

PayPal's Google Pay component interacts with your JavaScript code in 2 areas:

1. Checking merchant eligibility and providing PaymentDataRequest parameters for Google Pay: paypal.Googlepay().config().
2. Handling the onPaymentAuthorized() callback: paypal.Googlepay().confirmOrder().

Check for device and merchant eligibility before setting up the GooglePay Button.

The PayPal JavaScript SDK API paypal.Googlepay().config() response object provides the allowedPaymentMethods parameter, which is part of the" "} Google API's isReadyToPayRequest object.

Check whether the Google Pay API supports a device, browser, and payment method:

• Add allowedPaymentMethods to the isReadyToPayRequest.
• Call the isReadyToPay() method to check compatibility and render the Google Pay Button.

1/**
2 * Initialize Google PaymentsClient after Google-hosted JavaScript has loaded
3 *
4 * Display a Google Pay payment button after confirmation of the viewer's
5 * ability to pay.
6 */
7function onGooglePayLoaded() {
8  const paymentsClient = getGooglePaymentsClient();
9  paymentsClient.isReadyToPay(isReadyToPayRequest)
10      .then(function(response) {
11        if (response.result) {
12          addGooglePayButton();
13        }
14      })
15      .catch(function(err) {
16        console.error(err);
17      });
18}
19/**
20 * Add a Google Pay purchase button
21 */
22function addGooglePayButton() {
23  const paymentsClient = getGooglePaymentsClient();
24  const button =
25      paymentsClient.createButton({
26        onClick: onGooglePaymentButtonClicked /* To be defined later */,
27        allowedPaymentMethods: [baseCardPaymentMethod]
28      });
29  document.getElementById('container').appendChild(button);
30}

5. Create PaymentDataRequest

The PaymentDataRequest object manages the Google Pay payment process on the web. Create a new PaymentDataRequest each time a buyer explicitly requests a payment, such as inside the onclick handler for the Google Pay Button.

For each checkout session, create a `PaymentDataRequest` object, which includes information about payment processing capabilities, the payment amount, and shipping information.

The response object of the PayPal JavaScript SDK API paypal.Googlepay().config() provides the following parameters in the PaymentDataRequest object:

• allowedPaymentMethods
• merchantInfo

1/* Note: the `googlePayConfig` object in this request is the response from `paypal.Googlepay().config()` */
2async function getGooglePaymentDataRequest() {
3  const googlePayConfig = await paypal.Googlepay().config();
4  const paymentDataRequest = Object.assign({}, baseRequest);
5  paymentDataRequest.allowedPaymentMethods = googlePayConfig.allowedPaymentMethods;
6  // Uncomment for Japan integrations only
7  // paymentDataRequest.allowedPaymentMethods[0].parameters.allowedAuthMethods = ['PAN_ONLY'];
8  paymentDataRequest.transactionInfo = getGoogleTransactionInfo();
9  paymentDataRequest.merchantInfo = googlePayConfig.merchantInfo;
10  paymentDataRequest.callbackIntents = ["PAYMENT_AUTHORIZATION"];
11  return paymentDataRequest;
12}
13function getGoogleTransactionInfo(){
14    return {
15        currencyCode: 'USD',
16        totalPriceStatus: 'FINAL',
17        totalPrice: '100.00' // Your amount
18      }
19}

For more details about the response parameters, see the ConfigResponse section.

For more details about how Google Pay handles paymentDataRequest, refer to steps 8, 9, and 10 in Google's developer documentation.

Register click handler

Register a click event handler for the Google Pay purchase button. Call loadPaymentData() in the event handler when the user interacts with the purchase button and pass the PaymentDataRequest object.

1/* Show Google Pay payment sheet when Google Pay payment button is clicked */
2async function onGooglePaymentButtonClicked() {
3  const paymentDataRequest = await getGooglePaymentDataRequest();
4  const paymentsClient = getGooglePaymentsClient();
5  paymentsClient.loadPaymentData(paymentDataRequest);
6}

Add the click handler onGooglePaymentButtonClicked to the Button defined in Set up your Google Pay button.

For more details about paymentDataRequest refer to step 9 in Google's developer documentation.

onpaymentauthorized callback

Google calls the onPaymentAuthorized() callback with a PaymentData object when a customer consents to your site collecting their payment information and optional contact details.

Register the onPaymentAuthorized() callback as part of the PaymentClient initialization as shown in Google Pay's Client Reference page.

Create an order by using the PayPal Orders V2 API. Use paypal.Googlepay().confirmOrder() to send the orderID, the Google Pay Payment Data, and optional contact details, and confirm the order.

Confirm the order using the paypal.Googlepay().confirmOrder() method in the API SDK Reference.

If the order confirmation status is APPROVED, capture the order using the Capture payment for order endpoint of the PayPal Orders V2 API.

For more details, see step 11 of Google's developer documentation.

1async function processPayment(paymentData) {
2  return new Promise(async function (resolve, reject) {
3    try {
4        // Create the order on your server
5        const {id} = await fetch(`/orders`, {
6        method: "POST",
7        body:
8        // You can use the "body" parameter to pass optional, additional order information, such as:
9        // amount, and amount breakdown elements like tax, shipping, and handling
10        // item data, such as sku, name, unit_amount, and quantity
11        // shipping information, like name, address, and address type
12      });
13      const confirmOrderResponse = await paypal.Googlepay().confirmOrder({
14          orderId: id,
15          paymentMethodData: paymentData.paymentMethodData
16        });
17      /** Capture the Order on your Server  */
18      if(confirmOrderResponse.status === "APPROVED"){
19           const response =  await fetch(`/capture/${id}`, {
20              method: 'POST',
21            }).then(res => res.json());
22          if(response.capture.status === "COMPLETED")
23              resolve({transactionState: 'SUCCESS'});
24          else
25              resolve({
26                transactionState: 'ERROR',
27                error: {
28                  intent: 'PAYMENT_AUTHORIZATION',
29                  message: 'TRANSACTION FAILED',
30                }
31      })
32      } else {
33           resolve({
34            transactionState: 'ERROR',
35            error: {
36              intent: 'PAYMENT_AUTHORIZATION',
37              message: 'TRANSACTION FAILED',
38            }
39          })
40      }
41    } catch(err) {
42      resolve({
43        transactionState: 'ERROR',
44        error: {
45          intent: 'PAYMENT_AUTHORIZATION',
46          message: err.message,
47        }
48      })
49    }
50  });
51}

Customize payment experience

Customize the payment experience using the Google Pay JavaScript SDK. The following table shows the 2 most popular Google Pay customizations:

6. Put it all together

The following code samples show a Google Pay integration:

1<!DOCTYPE html>
2<html lang="en">
3  <head>
4    <meta charset="UTF-8" />
5    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
6    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
7    <title>Googlepay Example</title>
8    <script src="./script.js"></script>
9    <script src="https://www.paypal.com/sdk/js?client-id=<client_id>&components=googlepay"></script>
10    <link rel="stylesheet" type="text/css" href="styles.css" />
11  </head>
12  <body>
13    <main>
14      <section>
15        <div id="button-container"></div>
16      </section>
17    </main>
18    <script src="https://pay.google.com/gp/p/js/pay.js"></script>
19    <script>
20      document.addEventListener("DOMContentLoaded", (event) => {
21        if (google && paypal.Googlepay) {
22          onGooglePayLoaded().catch(console.log);
23        }
24      });
25    </script>
26  </body>
27</html>

Strong Customer Authentication (SCA)

When the ConfirmOrder status is PAYER_ACTION_REQUIRED, the order requires additional authentication from the payer, such as 3D Secure.

The PayPal JavaScript SDK Client provides an API to handle 3DS Secure authentication. Pass the orderId to initiatePayerAction.

When the payer completes authentication, confirm that the liability_shift status has shifted:

• Make a call to the Show order details endpoint of the Orders v2 API, using the id of the order.
• Check the liability_shift status in the authentication_response.

1...
2const { status } = await paypal.Googlepay().confirmOrder({
3  orderId: id,
4  paymentMethodData: paymentData.paymentMethodData,
5});
6if (status === "PAYER_ACTION_REQUIRED") {
7  console.log("==== Confirm Payment Completed Payer Action Required =====");
8  paypal
9    .Googlepay()
10    .initiatePayerAction({ orderId: id })
11    .then(async () => {
12      console.log("===== Payer Action Completed =====");
13      /** GET Order */
14      const orderResponse = await fetch(`/orders/${id}`, {
15        method: "GET",
16      }).then((res) => res.json());
17      console.log("===== 3DS Contingency Result Fetched =====");
18      console.log(
19        orderResponse?.payment_source?.google_pay?.card?.authentication_result
20      );
21      /* CAPTURE THE ORDER*/
22      const captureResponse = await fetch(`/orders/${id}/capture`, {
23        method: "POST",
24      }).then((res) => res.json());
25      console.log(" ===== Order Capture Completed ===== ");
26    });
27}
28...

7. Test your integration

Test your Google Pay integration in the PayPal sandbox and production environments to ensure that your app works correctly.

Sandbox

Use your personal sandbox login information during checkout to complete a payment using Google Pay. Then, log into the sandbox site sandbox.paypal.com to see that the money has moved into your account.

1. Open your test page with a supported web browser on any supported device.
2. Add a test card to your Google Wallet on your device. Google provides test cards through their Test card suite.
3. Tap the Google Pay button to open a pop-up with the Google Pay payment sheet.
4. Make a payment using the Google Pay payment sheet.
5. If you have an additional confirmation page on your merchant website, continue to confirm the payment.
6. Log in to your merchant account and continue to your confirmation page to confirm that the money you used for payment showed up in the account.

Google Pay test card suite

Use Google Pay test card numbers to test your Google Pay integration.

8. Go live

Make Google Pay available to buyers using your website or app.

Live environment

If you're a new merchant, sign up for a PayPal business account.

Use your personal production login information during checkout to complete a Google Pay transaction. Then log into paypal.com to see the money move out of your account.

Testing in your live environment

When testing a purchase in production, consider:

• The business account receiving money can't also make the purchase.
• If you create a personal account with the same information as the business account, those accounts might experience restrictions.

How to test Google Pay payments in a live environment:

1. Open your test page with a supported browser.
2. Select the Google Pay button to open a pop-up with the Google Pay payment sheet.
3. Proceed with the Google Pay checkout transaction.
4. If you have an additional confirmation page on your merchant website, continue to confirm the payment.
5. Log in to your merchant account and confirm that the money has moved into that account.

Troubleshoot your integration

Make sure that there are no browser console warnings or errors. The JavaScript SDK configuration attributes have distinct validation checks for input formatting and values.

If the validation fails, the web browser's developer console shows warning messages that say which property is incorrect and what you need to do to address the issue. The library generally attempts to revert to the safe default values if missing or incorrect inputs exist.

SDK API reference

This section provides details about functions, objects, and parameters in the SDK API.

Initialize payment with paypal.Googlepay()

Creates an instance of a PayPal Google Pay SDK Client.

Arguments

None

Returns

JavaScript SDK Client

JavaScript SDK client methods

Use the JavaScript SDK client methods to start a Google Pay payment and confirm an order.

Request objects

Use the following JavaScript SDK request objects in a Google Pay payment:

Response objects

Google Pay responses include the following objects: