AlipaySDK.h 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. //
  2. // AlipaySDK.h
  3. // AlipaySDK
  4. //
  5. // Created by antfin on 17-10-24.
  6. // Copyright (c) 2017年 AntFin. All rights reserved.
  7. //
  8. ////////////////////////////////////////////////////////
  9. ///////////////// 支付宝标准版本支付SDK ///////////////////
  10. ///////// version:15.8.16 modify:2023.08.02///////////
  11. ////////////////////////////////////////////////////////
  12. #import <UIKit/UIKit.h>
  13. #import "APayAuthInfo.h"
  14. #import "AFServiceCenter.h"
  15. #import "AFServiceResponse.h"
  16. typedef void(^CompletionBlock)(NSDictionary *resultDic);
  17. typedef enum {
  18. ALIPAY_TIDFACTOR_IMEI,
  19. ALIPAY_TIDFACTOR_IMSI,
  20. ALIPAY_TIDFACTOR_TID,
  21. ALIPAY_TIDFACTOR_CLIENTKEY,
  22. ALIPAY_TIDFACTOR_VIMEI,
  23. ALIPAY_TIDFACTOR_VIMSI,
  24. ALIPAY_TIDFACTOR_CLIENTID,
  25. ALIPAY_TIDFACTOR_APDID,
  26. ALIPAY_TIDFACTOR_MAX
  27. } AlipayTidFactor;
  28. @interface AlipaySDK : NSObject
  29. /**
  30. * 创建支付单例服务
  31. *
  32. * @return 返回单例对象
  33. */
  34. + (AlipaySDK *)defaultService;
  35. /**
  36. * 用于设置SDK使用的window,如果没有自行创建window无需设置此接口
  37. */
  38. @property (nonatomic, weak) UIWindow *targetWindow;
  39. //////////////////////////////////////////////////////////////////////////////////////////////
  40. //////////////////////////支付宝支付相关接口/////////////////////////////////////////////////////
  41. //////////////////////////////////////////////////////////////////////////////////////////////
  42. /**
  43. * 支付接口
  44. *
  45. * @param orderStr 支付订单信息字串
  46. * @param schemeStr 调用支付的app注册在info.plist中的scheme
  47. * @param completionBlock 支付结果回调Block,用于wap支付结果回调,跳转支付宝支付时只有当processOrderWithPaymentResult接口的completionBlock为nil时会使用这个bolock
  48. */
  49. - (void)payOrder:(NSString *)orderStr
  50. fromScheme:(NSString *)schemeStr
  51. callback:(CompletionBlock)completionBlock;
  52. /**
  53. * 支付接口 v2
  54. *
  55. * @param orderStr 支付订单信息字串
  56. * @param dynamicLaunch 是否使用动态配置策略跳转支付宝支付
  57. * @param schemeStr 调用支付的app注册在info.plist中的scheme
  58. * @param completionBlock 支付结果回调Block,用于wap支付结果回调
  59. 跳转支付宝支付时只有当processOrderWithPaymentResult接口的completionBlock为nil时会使用这个bolock
  60. */
  61. - (void)payOrder:(NSString *)orderStr
  62. dynamicLaunch:(BOOL)dynamicLaunch
  63. fromScheme:(NSString *)schemeStr
  64. callback:(CompletionBlock)completionBlock;
  65. /**
  66. * 处理支付宝app支付后跳回商户app携带的支付结果Url
  67. *
  68. * @param resultUrl 支付宝app返回的支付结果url
  69. * @param completionBlock 支付结果回调 为nil时默认使用支付接口的completionBlock
  70. */
  71. - (void)processOrderWithPaymentResult:(NSURL *)resultUrl
  72. standbyCallback:(CompletionBlock)completionBlock;
  73. /**
  74. * 商户接入UniversalLink支付接口使用该接口
  75. *
  76. * @param orderStr 支付订单信息字串
  77. * @param schemeStr 调用支付的app注册在info.plist中的scheme
  78. * @param universalLink 调用支付的app关联的universalLink,如'https://render.alipay.com/'
  79. * @param completionBlock 支付结果回调Block,用于wap支付结果回调,跳转支付宝支付时只有当processOrderWithPaymentResult接口的completionBlock为nil时会使用这个bolock
  80. */
  81. - (void) payOrder:(NSString *)orderStr
  82. fromScheme:(NSString *)schemeStr
  83. fromUniversalLink:(NSString *)universalLink
  84. callback:(CompletionBlock)completionBlock;
  85. /**
  86. * 处理支付宝app支付后通过universalLink跳回商户app携带的支付结果处理
  87. *
  88. * @param userActivity 系统接口传入的userActivity
  89. * @param completionBlock 支付结果回调 为nil时默认使用支付接口的completionBlock
  90. */
  91. - (void)handleOpenUniversalLink:(NSUserActivity *)userActivity standbyCallback:(CompletionBlock)completionBlock;
  92. /**
  93. * 获取交易token。
  94. *
  95. * @return 交易token,若无则为空。
  96. */
  97. - (NSString *)fetchTradeToken;
  98. //////////////////////////////////////////////////////////////////////////////////////////////
  99. //////////////////////////支付宝授权 2.0 相关接口////////////////////////////////////////////////
  100. //////////////////////////////////////////////////////////////////////////////////////////////
  101. /**
  102. * 快登授权2.0
  103. *
  104. * @param infoStr 授权请求信息字串
  105. * @param schemeStr 调用授权的app注册在info.plist中的scheme
  106. * @param completionBlock 授权结果回调,需要调用方在appDelegate中调用processAuth_V2Result:standbyCallback:方法获取授权结果
  107. * 若在授权过程中,调用方应用被系统终止则此block无效(此时会调用'processAuth_V2Result:standbyCallback:'传入的standbyCallback)
  108. */
  109. - (void)auth_V2WithInfo:(NSString *)infoStr
  110. fromScheme:(NSString *)schemeStr
  111. callback:(CompletionBlock)completionBlock;
  112. /**
  113. * 处理支付宝app授权后跳回商户app携带的授权结果Url
  114. *
  115. * @param resultUrl 支付宝app返回的授权结果url
  116. * @param completionBlock 授权结果回调,用于处理跳转支付宝授权过程中商户APP被系统终止的情况
  117. */
  118. - (void)processAuth_V2Result:(NSURL *)resultUrl
  119. standbyCallback:(CompletionBlock)completionBlock;
  120. //////////////////////////////////////////////////////////////////////////////////////////////
  121. //////////////////////////支付宝授权 1.0 相关接口////////////////////////////////////////////////
  122. //////////////////////////////////////////////////////////////////////////////////////////////
  123. /**
  124. * 快登授权
  125. * @param authInfo 授权相关信息
  126. * @param completionBlock 授权结果回调,若在授权过程中,调用方应用被系统终止,则此block无效,
  127. 需要调用方在appDelegate中调用processAuth_V2Result:standbyCallback:方法获取授权结果
  128. */
  129. - (void)authWithInfo:(APayAuthInfo *)authInfo
  130. callback:(CompletionBlock)completionBlock;
  131. /**
  132. * 处理支付宝app授权后跳回商户app携带的授权结果Url
  133. *
  134. * @param resultUrl 支付宝app返回的授权结果url
  135. * @param completionBlock 授权结果回调
  136. */
  137. - (void)processAuthResult:(NSURL *)resultUrl
  138. standbyCallback:(CompletionBlock)completionBlock;
  139. //////////////////////////////////////////////////////////////////////////////////////////////
  140. //////////////////////////支付宝 h5 支付转 native 支付接口////////////////////////////////////////
  141. //////////////////////////////////////////////////////////////////////////////////////////////
  142. /**
  143. * 从h5链接中获取订单串并支付接口(自版本15.4.0起,推荐使用该接口)
  144. *
  145. * @param urlStr 拦截的 url string
  146. *
  147. * @return YES为成功获取订单信息并发起支付流程;NO为无法获取订单信息,输入url是普通url
  148. */
  149. - (BOOL)payInterceptorWithUrl:(NSString *)urlStr
  150. fromScheme:(NSString *)schemeStr
  151. callback:(CompletionBlock)completionBlock;
  152. //////////////////////////////////////////////////////////////////////////////////////////////
  153. //////////////////////////支付宝 tid 相关信息获取接口/////////////////////////////////////////////
  154. //////////////////////////////////////////////////////////////////////////////////////////////
  155. /**
  156. * 获取当前tid相关信息
  157. *
  158. * @return tid相关信息
  159. */
  160. - (NSString*)queryTidFactor:(AlipayTidFactor)factor;
  161. //////////////////////////////////////////////////////////////////////////////////////////////
  162. //////////////////////////支付宝支付环境相关信息接口//////////////////////////////////////////////
  163. //////////////////////////////////////////////////////////////////////////////////////////////
  164. /**
  165. * 是否已经使用过
  166. *
  167. * @return YES为已经使用过,NO反之
  168. */
  169. - (BOOL)isLogined;
  170. /**
  171. * 获取当前版本号
  172. *
  173. * @return 当前版本字符串
  174. */
  175. - (NSString *)currentVersion;
  176. /**
  177. * 測試所用,realse包无效
  178. *
  179. * @param url 测试环境
  180. */
  181. - (void)setUrl:(NSString *)url;
  182. /**
  183. * 支付前主动更新本地配置
  184. *
  185. * @param block 更新请求结果回调
  186. */
  187. - (void)fetchSdkConfigWithBlock:(void(^)(BOOL success))block;
  188. typedef void(^APLogBlock)(NSString *log);
  189. /**
  190. * 接收AlipaySDK的log信息
  191. *
  192. * @param logBlock 打印log的回调block
  193. */
  194. + (void)startLogWithBlock:(APLogBlock)logBlock;
  195. /**
  196. * 停止输出log,会释放logBlock
  197. *
  198. *
  199. */
  200. + (void)stopLog;
  201. @end