iOS

After you download the SDK package in Alipay Developer Center, add AMSComponent.framework and AlipayWebView.framework to your project,  add AlipayWebView.framework/IWebContainer.bundle and AMSComponent.framework/AMSComponent.bundle, and go to Build Settings > Linking > Other Linker Flags to add -ObjC.

After you have obtained available payment methods by contacting Alipay Technical Support, you can display the payment methods in the following modes:

• Single bank mode: Display the payment methods by bank.
• Bank type mode: Display the payment method by bank type, such as mobile banking app, online banking, and bank transfer.
• Bank country mode: Desplay the payment methods by bank country, such as Thailand and Indonesia.

1. Create an instance for cashier pages. The instance contains the following parameter:
   • configuration: A required object belonging to the AMSConfiguration type. The object must contain all configuration parameters.
2. Create the AMSConfiguration class, which must contain the following parameters:
   • locale: An optional string belonging to the NSString type, 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.
     • en_US: English
     • in_ID: Indonesian
     • th_TH: Thai
   • options: An optional parameter belonging to the NSDictionary type. 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 enviroment
     • "showLoading", "true": Use the default loading pattern.
     • "showLoading", "false": Do not use the default loading pattern.
3. Create an instance of the AMSLoggerProtocol interface, which is used to manage log output. It contains the following method:
   • ​logWithName(): Optional. It is a callback function that is used to output logs by default.

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

Pass the following parameters in your createPaymentSession 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.

Use the createComponent method in the configuration object.

1. Create a configuration object by using the paymentSessionData parameter: Pass the paymentSessionData value obtained in Step 4 to the paymentSessionData parameter of the createComponent method.
2. Call the createComponent method to initialize the SDK.