Android

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("en", "US"): English
     • locale("in", "ID"): Indonesian
     • locale("th", "TH"): Thai
   • 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 interface, which is used for event handling in the subsequent process. The interface 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 interface in that of the configuration object to execute event callbacks.
4. Instantiate the AMSCashierPayment method.

After the user selects the payment method and your client detects the payment button click event, your server sends a createPaymentSession (Checkout Payment) request. Get the paymentSesssionData value from the createPaymentSession response and use it in Step 5.

Pass the following parameters in your createPaymentSession (Checkout Payment) request:

• paymentRequestId: The unique ID assigned by a merchant to identify a payment request. 

• productCode: Represents the payment product that is being used. The value is fixed as AGREEMENT_PAYMENT .  

• paymentNotifyUrl: The URL that is used to receive the payment result notification.

• paymentRedirectUrl: The merchant page URL that the user is redirected to after the payment is completed.
• paymentAmount: The payment amount that the merchant requests to receive in the order currency.
• order.orderAmount: The order amount on the merchant's part. During sales promotion, the orderAmount value may differ from the paymentAmount value.
• order.orderDescription: The order description.
• order.referenceOrderId: The order ID on the merchant's side. Alipay suggests using one referenceOrderId for multiple paymentRequestIds when there are multiple payment requests for a single order.
• paymentMethod.paymentMethodType: Specify it as BANK.
• paymentMethod.paymentMethodMetaData：
  • To display payment methods in the single bank mode, specify bankName as a bank name.
  • To display payment methods in the bank type mode, specify paymentMethodCaregory as a payment method type. Valid values are BANK_TRANSFER, MOBILE_BANKING_APP, and ONLINE_BANKING.
  • To display payment methods in the bank country mode, specify paymentMethodRegion as a country. Valid values are TH and ID.

Call the createComponent() method in the configuration object 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 paymentSessionData value obtained in Step 4 to the sessionData parameter of the createComponent method.

• 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.