Android

• Initialize the checkout instance with the following parameters:
  • configuration: Required. An object of typeAMSCashierPaymentConfiguration. The object must contain all of the following configuration parameters:
• Create an AMSCashierPaymentConfiguration object.  The object must contain all of the following configuration parameters:
  • locale: Optional. String type. It is used by the merchant client to identify the browser language and pass in the language information. The SDK uses the information to render the cashier page in the corresponding language. Valid values are listed as follows. If other values are passed, English is used by default: ​
    • "en", "US"：English
    • "es", "ES"：Spanish
    • "fr", "FR"：French
    • "nl", "NL"：Dutch
    • "it", "IT"：Italian
    • "de", "DE"：German
    • "zh", "CN"：Simplified Chinese
  • setOption: Optional. Used to specify whether to use the sandbox environment. Valid values are:
    • "sandbox", "true"：Sandbox environment.
    • "sandbox", "false"：Production Environment.
    • "showSubmitButton", "true"：Configure the SDK component to render the card binding button.
    • "showSubmitButton", "false"：Configures the merchant to render the card binding button, requiring invocation of the submit() function in the instance object to trigger the card binding submission process.
    • "notRedirectAfterComplete", "true"：Optional, Boolean type. The default value is false, which means it will jump back to your page after the payment is completed. The same applies when the value is empty. true value means there will be no jump after the payment is completed. You need to use the customer event code to control the card binding to complete the subsequent process. Please note that the payment result event code returned by the client is only used as a reference for the jump operation of the client page. For transaction status updates, please refer to the results returned by the server's notifyPayment or inquiryPayment API.
    • "merchantAppointmentParam"：Optional object used for setting custom features. It contains a value below:
      • storedCard：Optional object used for setting custom features of stored cards. It contains a value below:
        • needCVV：Optional Boolean. The default value is false, which indicates that the user do not need to input CVV number during the payment process. The same applies when the value is empty. true value means the user need to input CVV number during the payment process.
• Create an instance of the OnCheckoutListener API to handle corresponding events that occur in the subsequent process. It contains the following function:
  • OnEventCallback: Required. The card vaulting event callback function that returns eventCode and eventResult.
• Set the instance of the onCheckoutListener API to the configuration instance for executing event callbacks.
• Instantiate AMSCashierPayment。

The merchant client monitors the click events of the payment button itself. When the buyer selects the payment method and clicks the payment button, the merchant client initiates createPaymentSession request to the APO server. Once the response to the createPaymentSession request is received, the paymentSessionData value in the response is used in Step 4.

For card token payment mode with bound cards, you need to pass in the paymentMethod.paymentMethodId field to the card token returned to you by APO after the buyer binds the card. The way to obtain the card token is as follows:

• Independent card binding: Obtain the card token through the card.cardToken field in the asset binding result notification sent to you by APO.
• Non-independent card binding: Obtain the card token through the paymentResultInfo.cardToken field in the payment result notification sent to you by APO or the response to actively query the payment result.

• Use the mountComponent method in the instance object and pass the following parameters:
  • activity: Required. Activity type object, used to contain contextual parameter information for the current page.
  • appearance is AMSPaymentAppearance type.
    • "showSubmitButton", "true"：Configure the SDK component to render the payment button.
    • "showSubmitButton", "false"：Configure the merchant to render the payment button, while also calling the submit() method in the instance object to trigger the submission of the payment process.
  • ​​sessionData：Required. String type. Pass the complete data of the createPaymentSession field obtained from the response of session creation request into the paymentSessionData parameter of   sessionData.
  • parentViewGroup：Required, FrameLayout type, used to bind the view to the merchant's page layout. The layout parameter needs to be set to wrap_content. The SDK will automatically adjust the view width and height according to the size of the internal content of the view.
• Call the submit() method in the instance object:
  • Calling this function to initiate the payment transaction process and returns specific event codes. These event codes will also be returned via the onEventCallback .
  • If you need to pass in pre-collected billing address information for AVS verification, you can configure the following parameters to be passed in through the submit method.
    • billingAddress: Optional, Object type. Billing address information is used to identify the payer's identity and location. It contains the following parameters:
      • region: Required. String (2). ISO 3166 compliant 2-digit country code.
      • state: Optional. String (8). The name of the state, country, or province.
      • city: Optional. String (32). Name of the city, region, suburb, town or village.
      • address1: Optional. String (256). Address line 1, e.g., street address, P.O. Box, and company name.
      • address2: Optional. String (256). Address line 2, e.g., apartment, suite, unit, and building information.
      • zipCode: Optional. String (32). Zip code.

• Free resources of the SDK component by calling the unmount() method in the instance object. You need to unmount the component in the following cases:

  • When the buyer switches views and exits the payment page, free the component resources created in createPaymentSession.
  • When the buyer initiates multiple payment transactions, free the component resources previously created in createPaymentSession.
  • When the buyer completes a payment and notRedirectAfterComplete is true，which allows the buyer to receive a definitive payment result event code, free the component resources.

• SDK_PAYMENT_SUCCESSFUL: The payment Successful. Please redirect to the payment result page.
• SDK_PAYMENT_FAIL: The payment failed. Suggest checking the paymentResultCode error code message and re-initiating the payment.
• SDK_PAYMENT_PROCESSING: The payment is being processed. Suggest your server query the payment status or wait for the payment result notification.
• SDK_PAYMENT_ERROR: The payment status is abnormal. Suggest your server query the payment status or wait for the payment result notification.
• SDK_PAYMENT_CANCEL: The buyer did not click payment and closed the payment window. Can be used to re-invoke the SDK with paymentSessionData within its validity period. If expired, you need to request paymentSessionData again.
• SDK_FORM_VERIFICATION_FAILED: Form submission failed validation. The SDK will display form error codes on the element collection page.

The SDK may return the following payment status （paymentStatus）：

• SUCCESS: Payment Successful.
• FAIL: Payment failed.
• PROCESSING: The payment is processing.
• CANCELLED: The payment has been canceled.
• PENDING: The payment has been completed, please wait for the final payment result notification.

The SDK may return the following result codes (result.resultCode): 

The SDK may return the following result codes（paymentResultCode）：