Introduction

Google Pay is a widely used mobile payment solution that offers a convenient and secure way for customers to pay for goods and services. Integrating Google Pay with Payrails allows you to provide a fast, easy-to-use payment option for your customers while leveraging our platform to route the payment to any Payment Service Provider (PSP). This guide will explain the process of integrating Google Pay into your app or website using Payrails.

Pre-requisites

In order to start using Google Pay with Payrails, you must:

Integrate with Payrails using one of our SDKs or our API
Configure a new integration account for cards via one of the following Payment Service Providers:
Stripe, Checkout.com or Adyen
Enable Google Pay as a payment option.
Make sure you're sending the provider specific card meta fields (found under Merchant configurations -> Meta fields on your Payrails dashboard and in the examples below) in your requests.
Follow the setup steps in the Google Pay documentation below. The exact steps you must follow depend on the nature of your integration with Payrails. In any case, you must get your Google Pay implementation approved by Google as described here. Please then ensure to configure your Google Pay merchant ID in your SDK implementation as described here.

Google Pay on Android Devices

Google Pay on the Web

Ways to integrate

Payrails SDK

The simplest way to use Google Pay with Payrails is to use our drop-in in your checkout flow. With this integration type, no additional work is required to accept payments with Google Pay.

For a more flexible implementation using our SDK, you can use our Google Pay element. See special instructions here for your client-side implementation.

Server-to-server integration

You also have the option to completely manage your own client-side implementation, and use Payrails APIs with a server-to-server integration to process payments with Google Pay. With this approach, follow the Google documentation linked above to build Google Pay into your applications.

Pass Google Pay configuration in lookup response to Google Pay SDK

With a server-to-server integration, you can call our lookup payment options endpoint to get available payment options and relevant configurations for each payment method. You can get allowedAuthMethods and allowedCardNetworks from the response here and pass it to the Google Pay SDK. Please contact your Payrails representative during the onboarding phase in order to set these configurations before going live.

{
  "name": "lookup",
  "actionId": "bd879370-6935-4ff2-872e-fdb0c5ce3024",
  "executedAt": "2023-06-12T07:53:09.360484718Z",
  "data": {
    "paymentCompositionOptions": [
      {
        "integrationType": "api",
        "paymentMethodCode": "googlePay",
        "description": "GooglePay",
        "config": {
          "parameters": {
            "allowedAuthMethods": [
              "PAN_ONLY",
              "CRYPTOGRAM_3DS"
            ],
            "allowedCardNetworks": [
              "MASTERCARD",
              "VISA",
              "AMEX",
              "DISCOVER"
            ]
          },
          "tokenizationSpecification": {
            "parameters": {
              "gateway": "payrails",
              "gatewayMerchantId": "EXAMPLE_MERCHANT_ID"
            },
            "type": "PAYMENT_GATEWAY"
          },
          "type": "CARD"
        }
      }
    ]
  },
  "links": {
    "execution": "https://payrails-api.staging.payrails.io/merchant/workflows/payment-acceptance/executions/2ef29a74-d1ae-4fa5-a1d9-84e2cd710c23",
    "authorize": {
      "method": "POST",
      "href": "https://payrails-api.staging.payrails.io/merchant/workflows/payment-acceptance/executions/2ef29a74-d1ae-4fa5-a1d9-84e2cd710c23/authorize"
    }
  }
}

📘
Please setup your gatewayMerchantId with Payrails before you start testing your Google Pay integration in case of client owned Google Pay integration. Payrails performs validations on the merchant Id we receive after decrypting the token to ensure that we did not receive a forged token.

Pass Google Pay payment token in request to authorize payment with Payrails

When you initiate a transaction with the Google Pay SDK, a Payment Token (paymentMethodData.tokenizationData.token) containing a JSON-formatted string is sent to the merchant app. Pass the paymentMethodData.tokenizationData.token in your call to our authorize a payment endpoint. See an example below.

{
  "paymentComposition": [
    {
      "amount": {
        "currency": "USD",
        "value": "1.00"
      },
      "integrationType": "api",
      "paymentInstrumentData": {
        "billingAddress": {
          "country": {
            "code": "US"
          },
          "postalCode": "78759"
        },
        "card": null,
        "paymentToken": "{\"apiVersion\":2,\"apiVersionMinor\":0,\"paymentMethodData\":{\"description\":\"Amex •••• 0002\",\"info\":{\"assuranceDetails\":{\"accountVerified\":true,\"cardHolderAuthenticated\":false},\"billingAddress\":{\"countryCode\":\"US\",\"name\":\"Card Holder Name\",\"postalCode\":\"94043\"},\"cardDetails\":\"0002\",\"cardNetwork\":\"AMEX\"},\"tokenizationData\":{\"token\":\"{\\\"signature\\\":\\\"MEUCIQCkwDXS2WcYP8ChfrNh55gow99Gw0/njq+ZN+L1S01dGgIgXxL+Ftb1PrWcgPiJSXQX8xSSkw2WW1wn66gKbEd9DC0\\\\u003d\\\",\\\"protocolVersion\\\":\\\"ECv1\\\",\\\"signedMessage\\\":\\\"{\\\\\\\"encryptedMessage\\\\\\\":\\\\\\\"Z6NNDumB9omrYocB1hzmHRh8fP5iiqHlFtaohXS5C/RrelQgrmmLVpw8pLsbMsG64iMwsFIs5chSIOpbtJuRuhZ9b0NzbEbqVd0jweM2a5M0Ea1TlQi6YjnviLXjJCtCOhyFb/n2EuYUuMmqlUnu8pKrKEGjcS2TOkel6p2oN8N8BxLz2SNtJb8ubYhEuy7n7HKcaiuDwfnjr0a8tEcNSet0IeA8LXDKi/5OAM7/vCLFV+ZYlQ+UvSoF3O4ooKZXgpsRHc12IeneAev8+koA+omxoK5R8SInAogwQ0FclRVlA30T2C8VdR8IlL/9oGQK9KmSIjkIxYNakHptU41NTLrv/dH40ZwkBp9lGQ1Kuup4Y9M5IA8zjAM1vnIySNIv1lIGinrgALoEB6jt91qYDeHB9jtNArISiym5JfxZjCRUbj9SuyQH+ovKvuFhfqSoJgWaZYsAiwgTYpxLj8B8eSaFgFaUdjjNvvXkoBuLXYLVoU6Ecjkl30BTHnNfUa0XstNPQf6kAPnvMhl0e3KJ4g\\\\\\\\u003d\\\\\\\\u003d\\\\\\\",\\\\\\\"ephemeralPublicKey\\\\\\\":\\\\\\\"BIHW3CPNcYs5v27HWo4fZDSMXNJetlJESpz5TKX5R9pzh5mE0RwMOiy9HZp9ll4DoPiEVLLsHQaQE4EhBZ5GYfc\\\\\\\\u003d\\\\\\\",\\\\\\\"tag\\\\\\\":\\\\\\\"wzvb6aeZ6jmspk2vVq6O9uu+P1cfhzHLt5CExkPDOAU\\\\\\\\u003d\\\\\\\"}\\\"}\",\"type\":\"PAYMENT_GATEWAY\"},\"type\":\"CARD\"}}",
        "providerData": null,
        "vaultToken": ""
      },
      "paymentMethodCode": "googlePay",
      "storeInstrument": false
    }
  ]
}

Supported regions / countries

Region(s)	Countries
Europe	🇦🇹 Austria, 🇧🇪 Belgium, 🇧🇬 Bulgaria, 🇭🇷 Croatia, 🇨🇾 Cyprus, 🇨🇿 Czech Republic, 🇩🇰 Denmark, 🇪🇪 Estonia, 🇫🇮 Finland, 🇫🇷 France, 🇩🇪 Germany, 🇬🇮 Gibraltar, 🇬🇷 Greece, 🇭🇺 Hungary, 🇮🇸 Iceland, 🇮🇪 Ireland, 🇮🇹 Italy, 🇱🇻 Latvia, 🇱🇮 Liechtenstein, 🇱🇹 Lithuania, 🇱🇺 Luxembourg, 🇲🇹 Malta, 🇳🇱 Netherlands, 🇳🇴 Norway, 🇵🇱 Poland, 🇵🇹 Portugal, 🇷🇴 Romania, 🇸🇰 Slovakia, 🇸🇮 Slovenia, 🇪🇸 Spain, 🇸🇪 Sweden, 🇨🇭 Switzerland, 🇬🇧 UK, others..
North and Central America	🇺🇸 USA, 🇲🇽 Mexico, 🇨🇦 Canada, 🇵🇷 Puerto Rico, others..
South America	🇧🇷 Brazil, others..
Africa	🇲🇦 Morocco, 🇿🇦 South Africa
Asia Pacific	🇦🇺 Australia, 🇭🇰 Hong Kong, 🇯🇵 Japan, 🇲🇾 Malaysia, 🇳🇿 New Zealand, 🇸🇬 Singapore, 🇹🇭 Thailand, 🇦🇪 UAE, others..

Supported workflows and services

Workflow	Supported
Available via Payrails SDK	✔️
Available via Payrails API	✔️
Delayed / Manual Capture	✔️
Instant Capture	✔️
Cancel / Void	✔️
Refund / Reverse	✔️
Save Instruments	✔️
Merchant Initiated Transaction (MIT)	✔️
Interoperability	PSP tokens, Network tokens