Payment-method icon

Google Pay Component integration

Add Google Pay to an existing Components integration.

On this page, you can find additional configuration for adding Google Pay to your Component integration.

When shoppers select Google Pay, Component presents the Google Pay payment sheet where shoppers choose a card they want to use. If shoppers select a card that requires 3D Secure authentication, Component also handles redirecting shoppers to another website to complete the verification.

Before you begin

Before starting your Google Pay integration:

  • Build a Component integration.
  • Follow the setup steps in the Google Pay documentation.
  • Add Google Pay in your Customer Area.
  • API reference

    You don't need to send additional fields for Google Pay. See the /payments endpoint API reference for the optional fields you can send.

    Component configuration

    Pass state to your Checkout activity onActivityResult:

    Optional configuration

    You can optionally include the following properties when you configure AdyenCheckout:

    Property Description Default
    merchantAccount Your Google Merchant ID. This can be anything for testing. Before you go live, get your Google Merchant ID from the Google Pay & Wallet Console. The corresponding merchant ID value from the brands array in the /paymentMethods response.
    allowedCardNetworks The list of supported card networks that you support. -
    allowedAuthMethods The list of fields that are supported to authenticate a card transaction. Possible values:
    - PAN_ONLY:associated with payment cards stored on file with the user's Google Account. Returned payment data includes personal account number (PAN) with the expiration month and the expiration year.
    -CRYPTOGRAM_3DS: associated with cards stored as Android device tokens. Returned payment data includes a 3D Secure cryptogram generated on the device.
    totalPriceStatus The status of the total price. Possible values:
    - FINAL: the total price shown to the shopper doesn't change.
    - ESTIMATED: the total price can change based on the details of the response, such as sales tax based on the billing address.
    allowPrepaidCards Set to false to turn off support for prepaid cards. true: prepaid cards from supported card networks are supported.
    allowCreditCards Set to false to turn off support for credit cards. true
    billingAddressRequired Set to true to require the shopper to enter their full billing address. Only request this if it is required to process a transaction. false
    billingAddressParameters The expected fields returned if billingAddressRequired is set to true. For more information on the available fields, see Google Pay API documentation on billingAddressParameters . -
    emailRequired Set to true to require the shopper to enter their email address. false
    shippingAddressRequired Set to true to require the shopper to enter their shipping address. false
    shippingAddressParameters The expected fields returned if shippingAddressRequired is set to true. For more information on the available fields, see Google Pay API documentation on shippingAddressParameters . -
    existingPaymentMethodRequired Set to true to only show the payment button if a shopper can pay with a supported payment method.
    The value that says if the shopper can pay with each allowed payment method comes from the IsReadyToPayResponse.paymentMethodPresent object.
    googlePayEnvironment The environment for Google Pay. Possible values:
    - WalletConstants.ENVIRONMENT_TEST for test.
    - WalletConstants.ENVIRONMENT_TEST for live.
    The corresponding environment to the environment you set when configuring AdyenCheckout.

    To learn more about the optional request object options, check the Google Pay API documentation.

    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 start testing Google Pay, log in to a Google account and create a Google Pay wallet.

    There are two approaches to using this wallet for testing:

    Enroll your wallet in Google's test card suite. Test card suite pre-populates your wallet with a group of cards to use in the TEST environment. These are related to Adyen's collection of test cards, and cover scenarios including:

    • Cards stored as FPAN
    • Cards stored as DPAN (only when testing through native Android and Chrome on Android)
    • Cards enabled for 3DS2

    When you start the payment flow and open the list of test cards, each card is marked with the applicable scenario.

    You can check the status of a Google Pay test payment in your Customer Area > Transactions > Payments, whether you used a card from the test card suite or or not. Remember that cards outside the test card suite are mapped to an Adyen test card of the same brand.

    For more information, see Google Pay's test environment for Android.

    Before you go live

    We recommend that you test the scenarios described in Google Pay’s API reference for Android in your live environment.

    1. Make sure your API credential has the API Clientside Encryption Payments role. Check this in your live Customer Area or ask your Admin user to verify.
    2. Go to your live Customer Area to configure your Google Merchant ID.
    3. Complete all the steps in the Google Pay API deploy to production documentation for Android.

    In the live environment, note that 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.