iOS

目录：

1. 文档说明
2. 接口规范
   2.1 网络通信方式
   2.2 语法
   2.3 接口报文约定
3. SDK接口定义说明
   3.1 获取HPaySDK对象(微信SDK1.8.6.1前版本)
   3.1-1 获取HPaySDK对象(微信SDK1.8.6.1后版本)
   3.2 支付接口
   ~ 3.3 获取开通支付渠道
   3.4 前台同步返回结果处理
   3.5 返回码（retCode）
4. IOS相关文件下载

1. 文档说明

本文档着重说明iOS版接口接入互联网前置网关系统的技术性要求及相关接口解释。

2. 接口规范

2.1 网络通信方式

使用http协议，服务器点对点post方式进行数据通信。

2.2 语法

消息体采用XML格式描述，消息体的语法规则完全遵循JSON语法规则，并严格区分大小写。

2.3 接口报文约定

如图所示，引入libHPaySDK.a及其依赖包：

在工程info.plist设置中添加一个URL Types回调协议(“wx8af7b52abed1f836”)，如图所示：

在工程对应的plist文件中添加NSAppTransportSecurity（Dictionary） 并同时设置里面NSAllowsArbitraryLoads 属性值为 YES， 添加LSApplicationQueriesSchemes（Array）并加入uppaysdk、uppaywallet、uppayx1、uppayx2、uppayx3五个item，如图所示:

3. SDK接口定义说明

3.1 获取HPaySDK对象(微信SDK1.8.6.1前版本)

• 发起方：APP
• 方法说明：

    +(HPaySDK *)registerSDKPay:(NSString *)merchantNo url:(NSString *)url

• 参数说明：

3.1-1 获取HPaySDK对象(微信SDK1.8.6.1后版本)

• 发起方：APP
• 说明：由于苹果iOS 13系统版本安全升级，微信SDK在1.8.6.1版本进行了适配，支持通过Universal Links方式跳转完成应用安全校验，提升使用流程安全性。
• 方法说明：

    +(HPaySDK *)registerSDKPay:(NSString *)merchantNo url:(NSString *)url universalLink:(NSString *)universalLink;

• 参数说明：

3.2 支付接口

• 发起方：APP
• 所属对象: HPaySDK
• 方法说明：

  -(void)doPay:(NSString *)orderInfo sign:(NSString *)sign appSchema:(NSString *)appSchema viewController:(UIViewController *)viewController callback:(void(^)(NSDictionary *dict))callback  finishHandler:(void(^)(NSString *code, NSString *errMsg))finishHandler;

• 请求参数说明：

• orderInfo对象字段说明:

3.3 获取开通支付渠道

• 发起方：APP
• 注意：新版本SDK（2.0）不提供此方法，可通过服务端接口查询
• 所属对象: HPaySDK
• 方法说明：

  -(void)getOpenChannel:(NSString *)orderInfo sign:(NSString *)sign completeHandler:(void (^)(NSArray *array))completeHandler failHandler:(void(^)(NSString *code, NSString *errMsg))failHandler;

• 参数说明:

• orderInfo 由下列字段构成：

• NSArray 类型为ChannelResult,字段说明:

3.4 前台同步返回结果处理

• 发起方：APP
• 所属对象：SDKPay
• 方法说明：

-(bool)processOrder:(NSURL *)url callback:(void(^)(NSDictionary *))callback;

resultDict 包含两个参数:
RetCode    SUCCESS – 支付成功  FAIL – 支付失败
ErrMsg     错误消息描述
Callback   回调函数

该方法应该在AppDelegate.m 文件中

-(BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options 方法中调用

微信SDK1.8.6.1后版本需增加以下处理：
处理微信通过Universal Link启动App时传递的数据
该方法应该在AppDelegate.m文件中

application:continueUserActivity:restorationHandler: 方法中调用
/// @param universalLink 微信启动第三方应用时系统API传递过来的userActivity
/// @param callback resultDict 包含两个参数: RetCode SUCCESS – 支付成功  FAIL – 支付失败 ErrMsg 错误消息描述 (暂时不用传)
/// @return 结果
- (BOOL)handleOpenUniversalLink:(NSUserActivity *)universalLink
                       callback:(void(^)(NSDictionary *resultDict))callback;

3.5 返回码（retCode）

4. iOS相关文件下载

1. sdk见附件