API Reference

Our reference library for integrating with our API


Find answers to our most frequently asked questions

Classic Docs

Documentation for our Classic API

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.

To enable Google Pay in the UAE or Saudi Arabia, please request activation from your Customer Success Manager.


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 

Before going live, you are required to register with Google Pay and select as your payment processor. You will also need to whitelist your domain here. Note that you must be logged in as a Google Developer to do this. If not, you will be redirected to Google Pay's support page.

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>'


'allowedPaymentMethods': ['CARD','TOKENIZED_CARD'],
'paymentMethodTokenizationParameters': {
   'tokenizationType': 'PAYMENT_GATEWAY',
   'parameters': {
     'gateway': 'checkoutltd'
     'gatewayMerchantId': ''

private PaymentDataRequest createPaymentDataRequest() {
  PaymentDataRequest.Builder request =
      .addAllowedPaymentMethod(WalletConstants.PAYMENT_METHOD_CARD)                     .addAllowedPaymentMethod(WalletConstants.PAYMENT_METHOD_TOKENIZED_CARD)
  PaymentMethodTokenizationParameters params =
      .addParameter("gateway", "checkoutltd")
      .addParameter("gatewayMerchantId", "")


You will need to specify which card types and card schemes to support in your payment data request. 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’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.

Alternatively, if you want to decrypt the Google Pay token yourself and process a payment, follow our pay with a pre-decrypted token guide.

Use the details below to set up your request.


You can find the full list, as well as complete request and response examples, in our API reference.

Request example

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

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. Take 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

To start testing, you need to create a test account. Google may ask to see your implementation in the sandbox environment before giving you a merchant ID for production.

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.