SPay

来自于：官方立即使用

isInstalled config wxPay

概述

本模块封装了威富通微信支付开放SDK。适用于商户在移动端APP中集成微信支付功能。

商户APP调用微信提供的SDK调用微信，商户APP会跳转到微信，支付完后跳回到商户APP内，最后展示支付结果。

目前微信支付支持手机系统有：IOS（苹果）、Android（安卓）和WP（Windows Phone）。

有关威富通微信支付详情，参考威富通官网：https://open.swiftpass.cn/

使用此模块之前需先配置 config.xml 文件，方法如下

  • 名称：SPay
  • 参数：urlScheme、apiKey
  • 配置示例:
  1.   <feature name="SPay">
  2.     <param name="urlScheme" value="wxd0d84bbf23b4a0e4"/>
  3.     <param name="appid" value="wxd0d84bbf23b4a0e4"/>
  4.   </feature>

  • 字段描述:

    urlScheme：（必须配置）用于实现应用间跳转及数据交换，本应用可以启动微信客户端，也可以从微信客户端跳回本应用。urlScheme 的 value 值是从微信开放平台获取的 appid。appid 申请方法参考微信开放平台接入文档。

    apiKey：（必须配置）从微信开放平台获取的 appid，值与 urlScheme 相同。appid 申请方法参考微信开放平台接入文档。

注意：

iOS 平台上使用微信支付功能。需要在config里配置微信的白名单，否则无法跳转到微信APP支付。详情参考APICloud官方文档：白名单配置

微信支付流程

1，移动端用户提交订单到商户服务器

2，商户服务器请求威富通支付网关

3，威富通支付网关返回威富通支付的 Token 给商户服务器

4，商户服务器返回给移动端订单交易信息

5，移动端唤起威富通支付SDK（本模块），同时传入威富通 Tken

6，威富通SDK（本模块）给威富通服务器发起支付请求

7，威富通服务器向微信服务器发起支付请求

8，微信服务器向威富通服务器返回支付授权 Token

9，威富通服务器给移动端返回支付授权 Token

10，移动端SDK 唤起微信进行支付，跳转到微信支付页面

11，用户提交交易

12，返回交易结果，并跳转回本 APP

13，移动端获取支付结果

12.1，微信服务器收到用户提交的交易请求后会异步通知威富通服务器

12.2，威富通服务器将结果返回给商家服务器

12.3，商户服务器通知威富通服务器已收到支付结果

12.4，威富通服务器通知微信支付服务器已收到支付结果

注意：过程 2和3 在商户服务器端进行。本模块封装了过程5-13，其中7、8、9是威富通服务器端自动处理。

isInstalled

判断当前设备是否安装微信客户端

isInstalled(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     installed: true      //布尔型；true||false，当前设备是否安装微信客户端
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.                 //错误码：
  4.                 //-1（未知错误），
  5.                 //0（成功）
  6. }

示例代码

  1. var SPay = api.require('SPay');
  2. SPay.isInstalled(function(ret, err) {
  3.     if (ret.installed) {
  4.         alert("当前设备已安装微信客户端");
  5.     } else {
  6.         alert('当前设备未安装微信客户端');
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

config

配置微信支付的appid

config({params}, callback(ret))

params

appId：

  • 类型：字符串
  • 描述：微信支付的appid

示例代码

  1. var SPay = api.require('SPay');
  2. SPay.config({
  3.     appId: 'wxd0d84bbf23b4a0e4'
  4. });

可用性

iOS系统

可提供的1.0.0及更高版本

wxPay

调起微信支付

wxPay({params}, callback(ret))

params

amount：

  • 类型：数字
  • 描述：支付的金额精确到分，整数类型

token：

  • 类型：字符串
  • 描述：支支付授权码

service：

  • 类型：字符串
  • 描述：支付类型（如pay.weixin.app）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     payModel: {           //JSON对象；
  3.        payCode:,          //数字类型；支付返回状态码，详情参考下文附件
  4.        message:           //字符串类型；支付返回的文本说明信息
  5.     },
  6.     payDetail:{           //JSON对象；(Android无此字段)
  7.        body:'',           //字符串类型；商品描述
  8.        status:,           //数字类型；返回状态码
  9.        message:'',        //字符串类型；返回信息
  10.        money:,            //数字类型；支付金额 
  11.        out_trade:'',      //字符串类型；商户订单号
  12.        order_no:'',       //字符串类型；威富通订单号
  13.        transaction_id:'', //字符串类型；第三方订单号
  14.        mch_name:'',       //字符串类型；商户名
  15.        trade_time:'',     //字符串类型；支付时间
  16.        need_query:'',     //字符串类型；统一反扫是否需要继续扫描标示（Y需要查询，N 不需要查询）
  17.        trade_type:''      //字符串类型；交易类型
  18.     }
  19. }

支付状态码

  1. //二维码生成失败
  2.     SPayClientConstEnumPayQRMakeErro = 1000,
  4.     //生成二维码生成，等待扫描中
  5.     SPayClientConstEnumPayQRWaitScan = 1001,
  7.     //传入的支付类型无效
  8.     SPayClientConstEnumPayPositiveScansTypeInvalid = 1002,
  10.     //二维码等待扫码超时
  11.     SPayClientConstEnumPayQRWaitScanTimerOut = 1003,
  13.     //二维码在等待扫描的时候，用户退出了支付
  14.     SPayClientConstEnumPayUserOut = 1004,
  16.     //用户在选择支付类型的时候，选择了取消选择支付
  17.     SPayClientConstEnumCancelSelect = 1005,
  19.     //传入的参数错误
  20.     SPayClientConstEnumParameterError = 1100,
  22.     //TokenID失效
  23.      SPayClientConstEnumPayTokenIDInvalid = 400,
  25.     //TokenID未知
  26.     SPayClientConstEnumPayTokenIDUnknown = 401,
  28.     //二维码未支付
  29.     SPayClientConstEnumPayQRUnUse = 204,
  31.     //二维码被扫码，但是支付失败
  32.     SPayClientConstEnumPayQRPayErro = 202,
  34.     //app支付，支付失败
  35.     SPayClientConstEnumAppPayErro = 601,
  38.     //wap支付，支付失败
  39.     SPayClientConstEnumWapPayErro = 701,
  41.     //wap支付，用户取消了支付
  42.     SPayClientConstEnumWapPayOut = 702,
  44.     //wap支付，用户未支付
  45.     SPayClientConstEnumWapPayUnpay = 703,
  47.     //支付成功
  48.     SPayClientConstEnumPaySuccess = 201,
  50.     //反扫冲正成功
  51.     SPayClientConstEnumReverseScanPayReverseSuccess = 2001,
  53.     //反扫冲正失败
  54.     SPayClientConstEnumReverseScanPayReverseErro = 2002,
  56.     //反扫支付失败
  57.     SPayClientConstEnumReverseScanPayErro = 2003,
  59.     //用户在扫码界面直接退出的交易，交易失败
  60.     SPayClientConstEnumReverseScanCancelSelect = 2004,
  62.     //设备设备没有摄像头
  63.     SPayClientConstEnumNotCamera = 3001,
  65.     //设备摄像头权限访问受限
  66.     SPayClientConstEnumCameraNotOpen= 3002,
  68.     //手Q没有安装
  69.     SPayClientConstEnumQQNotOpen= 3003,
  71.     //微信没有安装（微信Wap支付时候用到）
  72.     SPayClientConstEnumWechatNotOpen= 3004,
  74.     //支付宝没有安装（支付宝Wap支付时候用到）
  75.     SPayClientConstEnumAlipayNotOpen = 3005
  76.      //app 签名错误、未注册APPID、项目设置APPID不正确、注册的APPID与设置的不匹配、其他异常等
  77.     SPayClientConstEnumAppPayErro_1= -1,
  78.      //app支付，用户取消了支付
  79.     SPayClientConstEnumAppPayOut = -2,

示例代码

  1. var SPay = api.require('SPay');
  2. SPay.wxPay({
  3.     service: 'pay.weixin.app',
  4.     token: '147430b88ea3622250ae32eca5151ffba',
  5.     amount: 1
  6. }, function(ret) {
  7.     api.alert({msg:JSON.stringify(ret)});
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本