Airwallex iOS SDK

Airwallex iOS SDK是一个框架，通过它可以在您的应用程序中轻松，快速和安全地完成付款。它提供了简单的功能，可以将敏感的信用卡数据直接发送到Airwallex，还提供了功能详细的界面，用于收集用户付款明细。

开始使用我们的集成指南和示例项目。

AWXOneOffSession *session = [AWXOneOffSession new];
session.countryCode = "Your country code";
session.billing = "Your shipping address";
session.returnURL = "App return url";
session.paymentIntent = "Payment intent";
session.autoCapture = "Whether the card payment will be captured automatically (Default YES)";
session.hidePaymentConsents = "Whether the stored cards should be hidden on the list (Default NO)"
session.paymentMethods = "An array of payment method type names" (Optional)

如果你想完成订阅，请创建订阅session.

AWXRecurringSession *session = [AWXRecurringSession new];
session.countryCode = "Your country code";
session.billing = "Your shipping address";
session.returnURL = "App return url";
session.currency = "Currency code";
session.amount = "Total amount";
session.customerId = "Customer id";
session.nextTriggerByType = "customer or merchant";
session.requiresCVC = "Whether it requires CVC (Default NO)";
session.merchantTriggerReason = "Unscheduled or scheduled";
session.paymentMethods = "An array of payment method type names" (Optional)

如果你想完成特定payment intent的订阅，请使用payment intent创建session。

AWXRecurringWithIntentSession *session = [AWXRecurringWithIntentSession new];
session.countryCode = "Your country code";
session.billing = "Your shipping address";
session.returnURL = "App return url";
session.paymentIntent = "Payment intent";
session.autoCapture = "Whether the card payment will be captured automatically (Default YES)";
session.nextTriggerByType = "customer or merchant";
session.requiresCVC = "Whether it requires CVC (Default NO)";
session.merchantTriggerReason = "Unscheduled or scheduled";
session.paymentMethods = "An array of payment method type names" (Optional)

显示付款流程

在结帐界面中，添加一个按钮，让客户输入或更改他们的付款方式。点击后，用AWXUIContext显示付款流程。

AWXUIContext *context = [AWXUIContext sharedContext];
context.delegate = ”The target to handle AWXPaymentResultDelegate protocol”;
context.session = session;
[context presentEntirePaymentFlowFrom:self];

处理付款结果

用户成功完成付款或出现错误后，您需要处理付款结果。

#pragma mark - AWXPaymentResultDelegate

- (void)paymentViewController:(UIViewController *)controller didCompleteWithStatus:(AirwallexPaymentStatus)status error:(nullable NSError *)error
{
    [controller dismissViewControllerAnimated:YES completion:^{
        // Status may be success/in progress/ failure / cancel
    }];
}

如果有需要，可以通过以下可选方法获取consent id，以便之后的支付使用。

- (void)paymentViewController:(UIViewController *)controller didCompleteWithPaymentConsentId:(NSString *)Id {
    // To do anything with this id.
}

低层API集成

你可以基于我们的低层API来构建完全由你自定义的UI

用卡和账单详情或者payment consent来确认卡支付

你仍然需要按照基础集成中的步骤来设置配置、intent和session, 除了显示付款流程的步骤由以下步骤代替:

AWXCardProvider *provider = [[AWXCardProvider alloc] initWithDelegate:"The target to handle AWXPaymentResultDelegate protocol" session:"The session created above"];
// After initialization, you will need to store the provider in your view controller or class that is tied to your view's lifecycle
self.provider = provider;

// Confirm intent with card and billing
[provider confirmPaymentIntentWithCard:"The AWXCard object collected by your custom UI" billing:"The AWXPlaceDetails object collected by your custom UI" saveCard:"Whether you want the card to be saved as payment consent for future payments"];

// Confirm intent with a payment consent object (AWXPaymentConsent)
[provider confirmPaymentIntentWithPaymentConsent:paymentConsent];

// Confirm intent with a valid payment consent ID only when the saved card is **network token**
[provider confirmPaymentIntentWithPaymentConsentId:@"cst_xxxxxxxxxx"];

你也需要提供你的顶栈控制器，我们会在此之上来展示额外的用户页（例如3DS校验页、警示页）

#pragma mark - AWXProviderDelegate

- (UIViewController *)hostViewController {
    // Your host view controller
}

- (void)provider:(AWXDefaultProvider *)provider didCompleteWithStatus:(AirwallexPaymentStatus)status error:(nullable NSError *)error {
    // You can handle different payment statuses and perform UI action respectively here
}

如果有需要，可以通过以下可选方法获取consent id，以便之后的支付使用。

- (void)provider:(AWXDefaultProvider *)provider didCompleteWithPaymentConsentId:(NSString *)Id {
    // To do anything with this id.
}

用Apple Pay provider或Redirect provider来发起支付

你仍然需要按照基础集成中的步骤来设置配置、intent和session, 除了显示付款流程的步骤由以下步骤代替:

AWXApplePayProvider *provider = [[AWXApplePayProvider alloc] initWithDelegate:"The target to handle AWXProviderDelegate protocol" session:"The one off session created with apple pay options"];
// AWXRedirectActionProvider *provider = [[AWXRedirectActionProvider alloc] initWithDelegate:"The target to handle AWXProviderDelegate protocol" session:"The one off session created"];

// After initialization, you will need to store the provider in your view controller or class that is tied to your view's lifecycle
self.provider = provider;

// Initiate the apple pay flow
 [provider startPayment];
// Confirm intent with a valid payment method name that supports redirect pay
// [provider confirmPaymentIntentWithPaymentMethodName:@"payment method name"];

你需要实现以下delegate方法来处理支付结果

#pragma mark - AWXProviderDelegate

- (void)provider:(nonnull AWXDefaultProvider *)provider didCompleteWithStatus:(AirwallexPaymentStatus)status error:(nullable NSError *)error {
    switch (status) {
    case AirwallexPaymentStatusSuccess:
       // handle success
        break;
    case AirwallexPaymentStatusFailure:
       // handle failure
        break;
    case AirwallexPaymentStatusCancel:
       // handle Apple Pay cancelled by the user
        break;
    default:
        break;
    }
}

设置微信支付

付款完成后，微信将重定向到商家的应用程序，并使用onRes()进行回调，然后在通知商家服务器后可以检索payment intent状态，因此请保持监听通知。

@interface AppDelegate () <WXApiDelegate>

@end

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [WXApi registerApp:@"WeChat app id" universalLink:@"https://airwallex.com/"];
    
    return YES;
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options
{
    return [WXApi handleOpenURL:url delegate:self];
}

/**
 You can retrieve the payment intent status after your server is notified
 */
- (void)onResp:(BaseResp *)resp
{
    if ([resp isKindOfClass:[PayResp class]]) {
        NSString *message = nil;
        PayResp *response = (PayResp *)resp;
        switch (response.errCode) {
            case WXSuccess:
                message = NSLocalizedString(@"Succeed to pay", nil);
                break;
            case WXErrCodeUserCancel:
                message = NSLocalizedString(@"User cancelled.", nil);
                break;
            default:
                message = NSLocalizedString(@"Failed to pay", nil);
                break;
        }
        
        UIAlertController *controller = [UIAlertController alertControllerWithTitle:nil
                                                                            message:message
                                                                     preferredStyle:UIAlertControllerStyleAlert];
        [controller addAction:[UIAlertAction actionWithTitle:NSLocalizedString(@"Close", nil) style:UIAlertActionStyleCancel handler:nil]];
        [self.window.rootViewController presentViewController:controller animated:YES completion:nil];
    }
}

@end

设置 Apple Pay

Airwallex iOS SDK 允许商户向客户提供 Apple Pay 作为付款方式。

首先确保 Apple Pay 已在应用中开启并配置。请参考 Apple 的官方文档.
确保 Apple Pay 已在您的 Airallex 账户中开启。
安装 Airwallex iOS SDK 时添加 Apple Pay 模组。
生成 Merchant Identifier 并配置 applePayOptions。

完成上述步骤后，Apple Pay 会作为一种选项出现在付款方式列表里。

AWXOneOffSession *session = [AWXOneOffSession new];
...
... configure other properties
...

session.applePayOptions = [[AWXApplePayOptions alloc] initWithMerchantIdentifier:@"Merchant Identifier"];

自定义 Apple Pay

你也可以自定义 Apple Pay 选项来限制支付场景和提供额外的信息。请参考 AWXApplePayOptions.h 头文件以获取更多信息。

AWXApplePayOptions *options = ...;
options.additionalPaymentSummaryItems = @[
    [PKPaymentSummaryItem summaryItemWithLabel:@"goods" amount:[NSDecimalNumber decimalNumberWithString:@"10"]],
    [PKPaymentSummaryItem summaryItemWithLabel:@"tax" amount:[NSDecimalNumber decimalNumberWithString:@"5"]]
];
options.merchantCapabilities = PKMerchantCapability3DS | PKMerchantCapabilityDebit;
options.requiredBillingContactFields = [NSSet setWithObjects:PKContactFieldPostalAddress, nil];
options.supportedCountries = [NSSet setWithObjects:@"AU", nil];
options.totalPriceLabel = @"COMPANY, INC.";

限制

目前 Apple Pay 我们支持以下几种支付系统：

Visa
MasterCard
ChinaUnionPay
Maestro (iOS 12+)
Amex
Discover
JCB

用户在 Apple Pay 的过程中只能选择这几种支付系统的卡片进行付款。

优惠卷也暂时不支持。

主题色

你可以通过下面代码自定义主题色。

UIColor *tintColor = [UIColor colorWithRed:97.0f/255.0f green:47.0f/255.0f blue:255.0f/255.0f alpha:1];
[AWXTheme sharedTheme].tintColor = tintColor;
[UIView.appearance setTintColor:tintColor];

示例

示例应用支持最新版的 Xcode。要运行示例项目，应遵循以下步骤。

克隆源代码

运行以下脚本将该项目克隆到本地磁盘。

git clone git@github.com:airwallex/airwallex-payment-ios.git

安装依赖项并打开项目

确保已经安装 Cocoapods，然后在项目目录下执行以下命令：

pod install

配置 API 密钥（可选）

在 Examples/Keys 目录下，编辑并更新 Keys.json 文件。

编译启动 Example 应用

如果没有更新密钥文件，你也可以通过实例应用里的设置界面配置 API 密钥。请确保点击 Generate customer 按钮然后再执行 Checkout。

贡献

我们欢迎任何形式的贡献，包括新功能，错误修复和文档改进。最好的贡献方式是提交请求 - 我们将尽快回复您的提交。如果您发现错误或有任何疑问，也可以提交问题。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README_zh_CN.md

README_zh_CN.md

Airwallex iOS SDK

目录

要求

集成

CocoaPods

Swift Package Manager

可集成的组件

Swift

基础集成

低层API集成

用卡和账单详情或者payment consent来确认卡支付

用Apple Pay provider或Redirect provider来发起支付

设置微信支付

设置 Apple Pay

自定义 Apple Pay

限制

主题色

示例

贡献

Files

README_zh_CN.md

Latest commit

History

README_zh_CN.md

File metadata and controls

Airwallex iOS SDK

目录

要求

集成

CocoaPods

Swift Package Manager

可集成的组件

Swift

基础集成

低层API集成

用卡和账单详情或者payment consent来确认卡支付

用Apple Pay provider或Redirect provider来发起支付

设置微信支付

设置 Apple Pay

自定义 Apple Pay

限制

主题色

示例

贡献