Subscription payment is a recurring automatic payment solution that enables merchants to collect payments periodically. With a one-time authorization, buyers can link their payment accounts to enjoy continuous subscription services, while supporting dynamic adjustments to subscription configurations (such as modifying cycle/amount, canceling renewal, or terminating services, etc.). The entire process is both efficient and secure.
This document provides integration instructions for the Google Pay payment method. Through the Google Pay service, buyers can make payments using credit or debit cards stored in their Google accounts. With Antom Payment Element, you do not need to integrate the Google Pay SDK separately. Payment Element will automatically load Google Pay for you and can be configured to support Google Pay as an express payment method. The following figures demonstrate the user experience of paying with Google Pay: - Before using Payment Element, you must complete the onboarding and publishing process in the Google Pay Merchant Console:
- Register an account and provide your business information as guided on the page. Your Google Pay ID is located in the upper-right corner of the console.
- Complete the Google Pay configuration as instructed:
- Configure domain allowlists: To ensure payment security, you must authorize your business domain(s). In the console, navigate to Business Profile > Google Pay API. Under the Integrate with your website section, click + Add website to include all official domains of your website.
Note: Web Element is implemented using Google Pay’s JavaScript library and cannot be used directly within a WebView in mobile applications. The payment page must be opened in a mobile browser. - Before you start integrating, read Integration guide and API overview to understand the integration steps of the server-side API and the precautions for calling the API. Furthermore, ensure the following prerequisites are met:
- Obtained your client ID
- Complete the key configuration
- Complete the configuration of paymentNotifyUrl to receive the asynchronous notification
- Integrate the server-side SDK package, install the server-side library, and initialize a request instance. For more details, refer to Server-side SDKs.
- Integrate the client-side SDK package by following the steps detailed in Integrate the SDK package for Web/WAP, and ensure to use the latest SDK version or no lower than 1.46.0.
Start your integration by taking the following steps:
- Create a payment session
- Invoke Payment Element
- Obtain the authorization result
- Capture
- Obtain subscription notifications
Step 1: Create a payment session
Server-side
Call the createPaymentSession (One-time Payments) API with order information to create a payment session and obtain the paymentSessionData required to invoke Payment Element. You can choose to either render Google Pay by specifying it yourself or use the Payment Element-rendered payment method list. Step 2: Invoke Payment Element
Client-side
Follow Step 2: Invoke Payment Element to use paymentSessionData to invoke Payment Element on your client. After the buyer clicks to submit payment, Payment Element will handle the entire flow based on the selected payment method, including displaying QR codes, redirecting to payment pages, performing 3DS authentication, and returning to the merchant’s result page. Step 3: Obtain the authorization result
Server-side
After the buyer completes the authorized payment or the payment times out, you can obtain the authorization result either by receiving asynchronous notifications from Antom or by proactively querying the result. For detailed steps, refer to Obtain the authorization or payment result. Step 4: Capture
Server-side
Antom provides both automatic and manual capture methods. You can choose based on your business needs. After initiating capture, you can obtain the result via asynchronous notification or active inquiry. You need to decide whether to ship goods based on the capture result. For specific operations, refer to Capture. Step 5: Obtain subscription notifications
Server-side
After the subscription relationship takes effect, Antom will send you the initial subscription notification and subscription renewal notifications. Refer to Step 5: Obtain subscription notifications to obtain the relevant notifications. The following figures demonstrate the user experience of paying with Google Pay: - Before using Payment Element, you must complete the onboarding and publishing process in the Google Pay Merchant Console:
- Register an account and provide your business information as guided on the page. Your Google Pay ID is located in the upper-right corner of the console.
- Complete the Google Pay configuration as instructed:
- Publish the application to Google Play according to Google Pay's requirements.
- Before you start integrating, read Integration guide and API overview to understand the integration steps of the server-side API and the precautions for calling the API. Furthermore, ensure the following prerequisites are met:
- Obtained your client ID
- Complete the key configuration
- Complete the configuration of paymentNotifyUrl to receive the asynchronous notification
- Integrate the server-side SDK package, install the server-side library, and initialize a request instance. For more details, refer to Server-side SDKs.
- Integrate the client-side SDK package by following the steps detailed in Integrate the SDK package for Android. Ensure to use the latest SDK version or no lower than 1.46.0, and use target API level 24 or later.
- Add the Maven dependency to your build.gradle file using the following code:
dependencies {
implementation 'com.alipay.antom.sdk:plugin-googlepay:1.0.0'
}
- (Optional) If your project has not integrated the official Google Pay SDK, add the following additional dependency:
dependencies {
// 18.1.3 is an example version number. Select the appropriate version based on your actual requirements
implementation 'com.google.android.gms:play-services-wallet:18.1.3'
}
Start your integration by taking the following steps:
- (Optional) Preload the SDK
- Create a payment session
- Invoke Payment Element
- Obtain the authorization result
- Capture
- Obtain subscription notifications
(Optional) Step 1: Preload the SDK
Client-side
Before creating a payment session, it is highly recommended that you preload the SDK to improve the rendering speed of the checkout page, reducing the waiting time for buyers during the payment. Follow the code example below to perform the preloading:
AMSPaymentElement.preload(getApplicationContext());
Step 2: Create a payment session
Server-side
Call the createPaymentSession (One-time Payments) API with order information to create a payment session and obtain the paymentSessionData required to invoke Payment Element. You can choose to either render Google Pay by specifying it yourself or use the Payment Element-rendered payment method list. Step 3: Invoke Payment Element
Client-side
Follow Step 3: Invoke Payment Element to use paymentSessionData to invoke Payment Element on your client. After the buyer clicks to submit payment, Payment Element will handle the entire flow based on the selected payment method, including displaying QR codes, redirecting to payment pages, performing 3DS authentication, and returning to the merchant’s result page. Step 4: Obtain the authorization result
Server-side
After the buyer completes the authorized payment or the payment times out, you can obtain the authorization result either by receiving asynchronous notifications from Antom or by proactively querying the result. For detailed steps, refer to Obtain the authorization or payment result. Step 5: Capture
Server-side
Antom provides both automatic and manual capture methods. You can choose based on your business needs. After initiating capture, you can obtain the result via asynchronous notification or active inquiry. You need to decide whether to ship goods based on the capture result. For specific operations, refer to Capture. Step 6: Obtain subscription notifications
Server-side
After the subscription relationship takes effect, Antom will send you the initial subscription notification and subscription renewal notifications. Refer to Step 6: Obtain subscription notifications to obtain the relevant notifications. After completing the subscription, you can perform the following actions:
Inquire subscription information
Server-side
After your subscription is confirmed, you can query the following subscription information:
Subscription trial
Server-side
Antom provides a subscription trial feature that allows buyers to experience a product or service for a limited time at no cost or at a discounted rate before officially purchasing a subscription plan. For more details, refer to Subscription trial. Subscription cancellation
Server-side
The subscription cancellation feature allows buyers to cancel their current subscription at any time when they no longer need to use the associated service. For more details, refer to Subscription cancellation. For successful payments, if the buyer requests cancellation or a refund on the same day, you can use Antom’s cancellation capability to cancel the order or release funds. Orders not yet completed can also be cancelled directly. For details, refer to Cancel. For successfully paid orders, if you need to issue a refund to the buyer, Antom provides two methods:
- Your operations staff can manually process refunds directly through Antom Dashboard.
- Call the refund API to initiate a refund.
Antom’s refund capabilities are as follows:
- Supports full refunds.
- Supports multiple partial refunds, with the total refunded amount not exceeding the captured amount.
Refer to Refund to learn about Antom refund rules and operation process. Antom provides dispute resolution services for contested transactions. For more information, refer to Dispute Guidance. Reconciliation
Server-side
After the transaction is completed, use the financial reports provided by Antom for reconciliation. For more information on how to reconcile and the settlement rules of Antom, please refer to Reconciliation. Antom also offers the following customization options:
- Specify payment methods: You can use API parameters to define which payment methods are displayed in Payment Element, control the order of the payment method list, and configure the display of express payment options.
- Payment method features: Learn about the characteristics of APM and card payments.
Card payment features also apply to Google Pay. The following table outlines the support status of these features for Google Pay: 
