Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution


In this topic, you'll learn how to integrate the card payment SDK into an Android client so that you can render cashier pages in a mobile application.


Before integrating the card payment SDK, familiarize yourself with the Integration guide and Overview. This will enable you to understand the steps for integrating server APIs and notes for calling the APIs. Also, ensure that you have completed the following tasks:

  • Obtain a client ID in Antom Dashboard.
  • Properly configure keys in Antom Dashboard .
  • Install the latest version of Android Studio.
  • Target at least Android 4.4 (API level 19) or higher.
  • Use Gradle 4.1 or earlier.
  • Configure a physical machine or simulator to run your application.
Key integration steps

Integrate the card payment SDK by following these steps:


Integrate the SDK package

Client side

To integrate the SDK package, please refer to Integrate the SDK Package.




Create an SDK instance by using the AMSCashierPayment method:

Client side

Follow these steps to create an SDK instance:

  1. Create a configuration object: A required object. The object must contain all of the following configuration parameters:
    • setLocale: An optional string, which is used by the merchant client to identify the language of the buyer's browser. Specify this parameter to ensure that the SDK displays pages in the correct language. The valid values are as follows. If any other values are passed, English will be used as the default language.
      • locale("es", "ES"): Spanish

      • locale("ko", "KR"): Korean

      • locale("pt", "BR"): Portuguese

      • locale("en", "US"): English

    • setOption: Optional. It is used to specify whether to use the default loading pattern and the sandbox environment. Valid values are:
      • "sandbox", "true": Sandbox environment
      • "sandbox", "false": Production environment
      • "showLoading", "true": Use the default loading pattern.
      • "showLoading", "false": Do not use the default loading pattern.
  2. Create an instance of the OnCheckoutListener API, which is used for event handling in the subsequent process. The API includes the following method:
    • onEventCallback: Required. A callback function that monitors payment events on the checkout page, returning eventCode and eventResult.
  3. Set the instance of the OnCheckoutListener API in that of the configuration object to execute event callbacks.
  4. Instantiate the AMSCashierPayment method.
Create an SDK instance:

Send a createPaymentSession (Checkout Payment) request to the Alipay server.

Client side

After the buyer selects a card payment method for payment, your client starts monitoring the payment button click event. When your client detects that the payment button is clicked, your server needs to send a createpaymentSession (Checkout Payment) request to the Alipay server. After you receive the response from the API call, use the value of the paymentSessionData parameter to complete Step 4.

Note: In your createPaymentSession (Checkout Payment) request, specify paymentRedirectUrl as the URL Scheme that you provide to redirect buyers to the payment result page upon payment completion.

The following sample for calling the createPaymentSession API includes mandatory parameters and several optional parameters.
The response sample of the API call is shown as follows:

Create a component for collecting payment factors by using the createComponent method in the instantiated object

Client side

Call the createComponent() method and pass in the following parameters:

  • activity: A required object belonging to the Activity type. It is used to include the information about context parameters on the current page.
  • sessionData: A required string. Pass the complete data in the paymentSessionData parameter obtained in the response through the createpaymentSession (Cashier Payment) API to the sessionData parameter.


Call the onDestroy() method to free SDK component resources in the following situations:

  • When the user exits the checkout page, free the component resources created in the createPaymentSession.
  • When the user initiates multiple payments, free the component resources created in the previous createPaymentSession.
Create a configuration object:
Event codes

The SDK provides the following status codes:

  • SDK_START_OF_LOADING: The loading animation starts to play during the payment component creation.

  • SDK_END_OF_LOADING: The loading animation ends during the payment component creation.

The SDK provides the following error codes:

  • SDK_INTERNAL_ERROR: The internal error of the SDK occurs. Contact Alipay Technical Support to resolve the issue.

  • SDK_CREATEPAYMENT_PARAMETER_ERROR: The parameters passed into the createComponent method are incorrect. Ensure the parameters are passed correctly and send a new request.

  • SDK_CALL_URL_ERROR: Represents one of the following cases:

    • The redirection to the merchant page failed to be executed.
    • The parameter paymentRedirectUrl in your createpaymentSession (Cashier Payment) request is not passed or passed incorrectly.
  • SDK_INTEGRATION_ERROR: Dependencies are not found. Ensure that the dependencies are added correctly and retry the integration process.

Code sample in key steps

The following code sample shows the key steps during integration. The sample does not include the code used for calling the createpaymentSession (Cashier Payment) API.