---
title: Before you start
showTOC: true
---

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](https://github.com/airwallex/airwallex-payment-ios?tab=readme-ov-file#swift-package-manager) and [CocoaPods](https://cocoapods.org/pods/AIRWALLEX). 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](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app) 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](https://github.com/airwallex/airwallex-payment-ios)

3. Ensure you specify version 6.1.1 or later.

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](https://cocoapods.org/).

You can add `Airwallex` for a comprehensive integration that includes everything except WeChat Pay:

```ruby
pod 'Airwallex', '~> 6.1.1'
```

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

```ruby
pod 'Airwallex/AirwallexPaymentSheet' # For UI integration. 
pod 'Airwallex/AirwallexPayment' # For low-level API integration
pod 'Airwallex/AirwallexWeChatPay' # Required for WeChat Pay integration
```

Run the following command:

```ruby
pod install
```

## Step 2: Set up your server to access Airwallex API

[Obtain your access token](/api#/Authentication/API_Access/_api_v1_authentication_login/post) using your unique Client ID and API key accessible via web app (Account > Developer > API keys).

Before processing a payment, your server must [create a PaymentIntent](/api#/Payment_Acceptance/Payment_Intents/_api_v1_pa_payment_intents_create/post) and pass it to the client. After the payment is completed, your server needs to [retrieve the PaymentIntent](/api#/Payment_Acceptance/Payment_Intents/_api_v1_pa_payment_intents__id_/get) to check the payment result.

## Step 3: Configure SDK

1. Import the module where you want to use the Airwallex iOS SDK

```swift
import Airwallex
```

2. Configure the working mode for SDK and the client secret

When your app starts:

- Set the mode for SDK to connect with different Airwallex server environments.

```swift
Airwallex.setMode(.demoMode); // .demoMode, .stagingMode, .productionMode
```

- Pass your client secret to the SDK, which can be obtained from the response of either [Create a Payment Intent](/api#/Payment_Acceptance/Payment_Intents/_api_v1_pa_payment_intents_create/post) and [Generate a client secret for a Customer](/api#/Payment_Acceptance/Customers/_api_v1_pa_customers__id__generate_client_secret/get).

```swift
AWXAPIClientConfiguration.shared().clientSecret = “Your client secret”;
```

