Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Google Pay for API only

Add Google Pay to an existing API-only integration.

Accept Google Pay payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Before you begin

These instructions explain how to add Google Pay to your existing API-only integration. The API-only integration works the same way for all payment methods. If you haven't done this integration yet, refer to our API-only integration guide.

Before starting your Google Pay integration:

  1. Make sure that you have set up your back end implementation.
  2. Add Google Pay in your test Customer Area.
  3. Integrate Google Pay API with Adyen as your gateway. Follow the procedure on Google Pay documentation to integrate your web or Android application.

    In the step where you choose a payment tokenization method, choose Gateway. Set adyen as your gateway and provide your merchant or company account name in the gatewayMerchantId parameter.

    "tokenizationSpecification": {
      "type": "PAYMENT_GATEWAY",
      "parameters": {
        "gateway": "adyen",
        "gatewayMerchantId": "YOUR_MERCHANT_ACCOUNT_NAME"  
      }
    }

Build your payment form for Google Pay

Show Google Pay as an available payment method in countries where Google Pay is supported. When the shopper selects Google Pay, they are presented with the payment sheet.

We provide logos for Google Pay which you can use on your payment form. For more information, refer to Downloading logos.

You can also submit a /paymentMethods request specifying:

  • countryCode: Country where Google Pay is supported. For example, NL.
  • amount.currency: Any supported currency. For example, EUR.
  • channel: Set this to Web if the payment is being initiated on the web, or Android for in-app payments.

In the response, you receive paymentMethod.type: paywithgoogle.

{
    "details": [
        {
            "key": "paywithgoogle.token",
            "type": "payWithGoogleToken"
        }
    ],
    "name": "Google Pay",
    "supportsRecurring": true,
    "type": "paywithgoogle"
}

Make a payment

  1. Get the token from  PaymentData response from the Google Pay API. 

  2. From your server, make a /payments request providing:

    • paymentMethod.type: paywithgoogle
    • paywithgoogle.token: This is the token that you obtained from the Google Pay API PaymentData  response.
    curl https://checkout-test.adyen.com/v50/payments \
    -H "x-API-key: YOUR_X-API-KEY" \
    -H "content-type: application/json" \
    -d '{
      "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
      "reference":"YOUR_ORDER_NUMBER",
      "amount":{
        "currency":"EUR",
        "value":1000
      },
      "paymentMethod":{
        "type":"paywithgoogle",
        "{hint:token from Google Pay API}paywithgoogle.token{/hint}": "QWIwMmI0YzAhQlFBQkFnQjMv.."
      },
      "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy..",
    }'
    # Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen::Client.new
    adyen.api_key = "YOUR_X-API-KEY"
     
    response = adyen.checkout.payments({
      :amount => {
        :currency => "EUR",
        :value => 1000
      },
      :reference => "YOUR_ORDER_NUMBER",
      :paymentMethod => {
        :type => "paywithgoogle",
        :paywithgoogle.token => "QWIwMmI0YzAhQlFBQkFnQjMv.."
      },
      :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
    })
    // Set YOUR_X-API-KEY with the API key from the Customer Area.
    // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
        Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
        Checkout checkout = new Checkout(client);
    
        PaymentsRequest paymentsRequest = new PaymentsRequest();
    
        String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
        paymentsRequest.setMerchantAccount(merchantAccount);
    
        Amount amount = new Amount();
        amount.setCurrency("EUR");
        amount.setValue(15000L);
        paymentsRequest.setAmount(amount);
    
        DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
        paymentMethodDetails.setType("paywithgoogle");
        paymentMethodDetails.setGooglepayToken("QWIwMmI0YzAhQlFBQkFnQjMv..")
        paymentsRequest.setPaymentMethod(paymentMethodDetails);
    
        paymentsRequest.setReference("YOUR_ORDER_NUMBER");
    
        PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    $client = new \Adyen\Client();
    $client->setXApiKey("YOUR_X-API-KEY");
    $service = new \Adyen\Service\Checkout($client);
    
    $params = array(
      "amount" => array(
        "currency" => "EUR",
        "value" => 1000
      ),
      "reference" => "YOUR_ORDER_NUMBER",
      "paymentMethod" => array(
        "type" => "paywithgoogle",
        "paywithgoogle.token" => "QWIwMmI0YzAhQlFBQkFnQjMv.."
      ),
      "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
    );
    $result = $service->payments($params);
    #Set your X-API-KEY with the API key from the Customer Area.
    adyen = Adyen.Adyen()
    adyen.client.xapikey = 'YOUR_X-API-KEY'
    
    result = adyen.checkout.payments({
       'amount': {
          'value': 1000,
          'currency': 'EUR'
       },
       'reference': 'YOUR_ORDER_NUMBER',
       'paymentMethod': {
          'type': 'paywithgoogle',
          'applepay.token': 'QWIwMmI0YzAhQlFBQkFnQjMv..'
       },
       'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
    })
    // Set your X-API-KEY with the API key from the Customer Area.
    var client = new Client ("YOUR_X-API-KEY", Environment.Test);
    var checkout = new Checkout(client);
    
    var amount = new Model.Checkout.Amount("EUR", 1000);
    var details = new Model.Checkout.DefaultPaymentMethodDetails{
      Type = "paywithgoogle",
      GooglePayToken = "QWIwMmI0YzAhQlFBQkFnQjMv.."
    };
    var paymentsRequest = new Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
      PaymentMethod = details
    };
    
    var paymentResponse = checkout.Payments(paymentsRequest);
    // Set your X-API-KEY with the API key from the Customer Area.
    const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
    const config = new Config();
    // Set your X-API-KEY with the API key from the Customer Area.
    config.apiKey = '[API_KEY]';
    config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
    const client = new Client({ config });
    client.setEnvironment("TEST");
    const checkout = new CheckoutAPI(client);
    checkout.payments({
        amount: { currency: "EUR", value: 1000 },
        paymentMethod: {
            type: 'paywithgoogle',
            paywithgoogle.token: 'QWIwMmI0YzAhQlFBQkFnQjMv..'
        },
        reference: "YOUR_ORDER_NUMBER",
        merchantAccount: config.merchantAccount
    }).then(res => res);

    The response contains the result of the payment.

    {
      "pspReference": "881539337151149C",
      "resultCode": "Authorised"
    }

    If the shopper used a card that requires 3D Secure authentication before the payment can be completed, you receive an action.type redirect in the response.

     {
       "resultCode": "RedirectShopper",
       "action": {
         "data": {
           "MD": "NGNsQ2QzN3hxMGtVN2lueUV5QWo3UT..",
           "PaReq": "eNpVUttygjAQ/RXrB5CES1..",
           "TermUrl": "https://your-company.com/checkout?shopperOrder=12xy.."
         },
         "method": "POST",
         "paymentData": "Ab02b4c0!BQABAgA2ndtJW6...==",
         "paymentMethodType": "scheme",
         "type": "redirect",
         "url": "https://test.adyen.com/hpp/3d/validate.shtml"
       },
       "details": [
         {
           "key": "MD",
           "type": "text"
         },
         {
           "key": "PaRes",
           "type": "text"
         }
       ],
       ...
     }
  3. If you received an action object, use the information in this object to redirect the shopper to another website to complete the 3D Secure authentication. Otherwise, proceed to presenting the payment result to your shopper.

Cards with 3D Secure: Handle the redirect

If the shopper used a card that requires 3D Secure authentication, you need to redirect the shopper to another website where they complete the authentication. After the shopper is redirected back to your website or app, make a /payments/details request to check the payment result.

For more information and detailed instructions, refer to Handling redirects.

Present the payment result

Use the resultCode that you received in the /payments or /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Google Pay are:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

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, you must:

  • Login to a real Google account.
  • Create a Google Pay wallet with valid card details. Google Pay does not accept test cards.

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 or for Android.

Before you go live

  1. Make sure you have the API Clientside Encryption Payments role enabled for your web service user. Check this in your live Customer Area or ask your Admin user to verify.
  2. Complete all the steps in the Google Pay API deploy to production documentation for Web or for Android.
  3. If you integrated Google Pay for Web, contact our Support Team and submit a request to configure your Google Pay merchantID .

In production, 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