Google Pay

By integrating Google Pay into your website or Android application, your customers can securely make one-touch payments using any credit or debit card connected to their Google account.

Overview

To start processing Google Pay payments, you must first integrate directly with Google. Once integration is complete, you can add the Google Pay button to your checkout page and start requesting your customers' encrypted payment information.

Google Pay integration and payments can be simplified into a three-step method:

  1. Integrate with Google Pay
  2. Tokenize the Google Pay payment data
  3. Request the payment

There is no liability shift!
Unlike with some other wallets, payments made via Google Pay do not benefit from any liability shift. You will be subject to the same liability rules and chargeback policies as with regular credit and debit card payments, as described here. In order to minimize the risk of fraud and chargebacks, you may want to restrict the type of payment cards you accept. For more information, see this section of the Google Pay API documentation.

Step 1: Integrate with Google Pay

Please note:
Before going live, you are required to register with Google Pay and select Checkout.com as your payment processor.

For information on integrating with Google Pay, first, refer to the Google Pay API guide.

When you submit a payment data request to the Google API, be sure to include the following parameters:

'gateway': 'checkoutltd'
'gatewayMerchantId': '<your public key>'

Examples

'allowedPaymentMethods': ['CARD','TOKENIZED_CARD'],
'paymentMethodTokenizationParameters': {
   'tokenizationType': 'PAYMENT_GATEWAY',
   'parameters': {
     'gateway': 'checkoutltd'
     'gatewayMerchantId': '<replace with your public key>'
   }
}
private PaymentDataRequest createPaymentDataRequest() {
  PaymentDataRequest.Builder request =
    PaymentDataRequest.newBuilder()
      .setTransactionInfo(
        TransactionInfo.newBuilder()
          .setTotalPriceStatus(WalletConstants.TOTAL_PRICE_STATUS_FINAL)
            .setTotalPrice("10.00")
            .setCurrencyCode("USD")
            .build())
      .addAllowedPaymentMethod(WalletConstants.PAYMENT_METHOD_CARD)                     .addAllowedPaymentMethod(WalletConstants.PAYMENT_METHOD_TOKENIZED_CARD)
      .setCardRequirements(
        CardRequirements.newBuilder()
          .addAllowedCardNetworks(
            Arrays.asList(
              WalletConstants.CARD_NETWORK_VISA,
              WalletConstants.CARD_NETWORK_MASTERCARD))
          .build());
  
  PaymentMethodTokenizationParameters params =
    PaymentMethodTokenizationParameters.newBuilder()
      .setPaymentMethodTokenizationType(
        WalletConstants.PAYMENT_METHOD_TOKENIZATION_TYPE_PAYMENT_GATEWAY)
      .addParameter("gateway", "checkoutltd")
      .addParameter("gatewayMerchantId", "<replace with your public key>")
      .build();

  request.setPaymentMethodTokenizationParameters(params);
  return request.build();
}

Please note:
You will need to specify which card types and card schemes to support in your payment data request. Checkout.com and Google Pay support the use of both Visa and Mastercard.

Step 2: Tokenize the Google Pay payment data

Once you have received the payment data from Google, you then need to call Checkout.com’s endpoint for tokenizing the encrypted payment data; you can find this payment data in the paymentMethodToken property of the Google Pay payment data request's response.

To find out more about Google Pay payment requests, read the Google Pay object reference.

The request

Use the details below to set up your request.

Endpoints

Live

https://api.checkout.com/tokens

Sandbox

https://api.sandbox.checkout.com/tokens

Header parameters

Header
Value

Authorization
Required

public key

Use the valid public key of your Checkout.com account. You can find this in the Hub.

Content-Type
Required

application/json

Body parameters

Field name
Description

type
String
required

The type of card details to be tokenized. Set this to googlepay.

token_data
String
required

The Google Pay payment token.

token_data.signature
String
required

Verifies the message came from Google. The signature is created using ECDSA.

token_data.protocolVersion
String
required

Identifies which encryption/signing scheme this message has been created. In this way, the protocol can evolve over time if needed. If it is not set, assume ECv0.

token_data.signedMessage
String
required

A serialized JSON string containing the encryptedMessage, ephemeralPublicKey and tag. To simplify the signature verification process, this value is serialized.

Request example

This following code snippet is an example of the request body for a Google Pay payment.

{
  "type": "googlepay",
  "token_data": {
    "protocolVersion": "ECv1",
    "signature": "TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ",
    "signedMessage": "{\"encryptedMessage\": \"ZW5jcnlwdGVkTWVzc2FnZQ==\", \"ephemeralPublicKey\": \"ZXBoZW1lcmFsUHVibGljS2V5\", \"tag\": \"c2lnbmF0dXJl\"}"
  }
}

The response

Response example

{
  "type": "googlepay",
  "token": "tok_ubfj2q76miwundwlk72vxt2i7q",
  "expires_on": "2018-10-22T15:44:03Z"
}

Step 3: Request a payment using Google Pay

Now you have the token, it's time to authorize the payment. Grab the token, and use it in the body of a card token payment request from your application or website's backend server.

Test Google Pay in sandbox

Google Pay does not allow the configuration of test cards within its online wallet. However, when using Google's test environment, if a real card is selected when making the online purchase, Google Pay provides a test card in the encrypted payment data; ensuring that no actual transaction takes place.

Find out more about testing and simulating payments.

Can we help?

Thanks for using Checkout.com. If you need any help or support, then message our support team at support@checkout.com.

Google Pay


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.