Airwallex logo

Before you start

Copy for LLMView as Markdown

Latest Release

The Airwallex iOS SDK is open source, fully documented .

Follow these steps to set up Airwallex iOS SDK.

Requirements

  • Requires Xcode 15.4 or later and is compatible with apps targeting iOS 13 or above
  • Available through Swift Package Manager and CocoaPods . Please install the latest version of CocoaPods to ensure you can add Airwallex SDK to your application.

Step 1: Set up SDK

Swift Package Manager

Airwallex for iOS is available via Swift Package Manager. To integrate it into your project, follow these steps:

  1. Follow Apple's guide on how to add a package dependency in Xcode.

  2. Use the following URL for the Airwallex package: https://github.com/airwallex/airwallex-payment-ios

  3. Specify the latest version shown in the badge above.

You can add Airwallex for a comprehensive integration that includes everything except WeChat Pay. Alternatively, you can selectively add specific products to your project for a more modular setup, depending on your payment needs:

  • AirwallexPaymentSheet: For UI integration.
  • AirwallexPayment: For low-level API integration.
  • AirwallexWeChatPay: Required for WeChat Pay integration.

CocoaPods

Airwallex for iOS is available via CocoaPods .

You can add Airwallex for a comprehensive integration that includes everything except WeChat Pay. Replace VERSION with the latest version shown in the badge above:

Ruby
1pod 'Airwallex', '~> VERSION'

Alternatively, you can selectively add specific products to your project for a more modular setup, depending on your payment needs:

Ruby
1pod 'Airwallex/AirwallexPaymentSheet' # For UI integration. 
2pod 'Airwallex/AirwallexPayment' # For low-level API integration
3pod 'Airwallex/AirwallexWeChatPay' # Required for WeChat Pay integration

Run the following command:

Ruby
1pod install

Step 2: Set up your server to access Airwallex API

Generate API keys from Settings > Developer > API keys tab in the web app. Authenticate from your server using your Client ID and API key to generate an access token before calling Payments APIs. For more information, see Manage API keys.

Before processing a payment, your server must create a PaymentIntent API and pass it to the client. After the payment is completed, your server needs to retrieve the PaymentIntent API to check the payment result.

Was this page helpful?