Files
property-resident-side/property-uniapp-project/uni_modules/liyahong-unionpay/readme.md
2026-06-04 17:55:18 +08:00

260 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
##插件功能概述
* 支持拉起云闪付并完成支付
* 支持检查是否安装云闪付
* 支持获取已安装的云闪付直通App列表
* 支持配置各个直通银行及手机支付(如小米支付、华为支付等)
* 支持Android/IOS/harmonyOS三端`本插件为原生SDK仅支持App端`
* 待完善功能。。。
##插件接入文档
### 关于更新
有空闲时间会不断更新维护,有问题随便提,有时间一定会修改!
### 特别推荐
其他插件请参考主页如人脸采集、百度OCR等深受广大用户青睐可以一试
* 作者主页:[https://ext.dcloud.net.cn/publisher?id=214114](https://ext.dcloud.net.cn/publisher?id=214114)
### 鸿蒙特殊说明`重要授权说明`
* uni-app项目: 由于官方目前不支持`试用以及普通授权`,建议`新建uni-appx项目`引用插件测通后购买源码授权使用
* uni-appx项目: 可直接使用
###准备工作
1. Android、ios、harmonyOS端证书准备工作
* 1) Android端准备应用的Android打包文件.jks文件。(`如使用官方证书忽略`)参考:[https://ask.dcloud.net.cn/article/35777](https://ask.dcloud.net.cn/article/35777)
* 2) IOS端这里只简单介绍一下windows系统下如何创建ios证书如果你是mac系统直接百度搜索就行网上一堆教程windows证书申请教程参考[https://www.pianshen.com/article/59121497532/](https://www.pianshen.com/article/59121497532/)
* 3) harmonyOS端usb连接真机 ---> 运行 ---> 运行手机或模拟器 ---> 运行到鸿蒙 ---> 配置证书(可以自动生成) ---> 运行
###接入步骤
#### 最简单的接入步骤基本10分钟搞定
* step1插件页右边有个`试用`的按钮,点它,然后弹出来一个模态框,选择`试用的项目`,点击`确认`按钮,点击`继续导入HBuilderX`
* step2将demo里面`index.vue`文件里面的函数方法复制过来
* step3打开你项目的`manifest.json`文件,找到`安卓/iOS常用其他设置`,找到`IOS设置` ---> `UrlSchemes`,将`uppaylyhuts`填写进去。如果你本来就有(比如你原来有XXX)则是:`XXX,uppaylyhuts`
* step4同上`安卓/iOS常用其他设置`中找到`IOS设置` ---> `应用访问白名单`,将`uppaywallet,uppaysdk,uppayx1,uppayx2,uppayx3,paesuperbank,ccbmbsylunionpay,bocom,bankabc,cmbmobilebank,cmblife,com.icbc.iphoneclient,spdbbank,spdbcccUnionPay,citicbankpay,credit,uppayxingyecredit,uppayhuaxiacredit,uppaybeijingcredit,uppayzhonghangcredit,uppayguangdacredit,uppaygonghangcredit,uppayjianhangcredit,uppayjiaohangcredit,uppayguangfa,psbccashier,uppayyouchucredit,com.cebbank.ebank,BankOfShangHai,boscgdlf,citicbankdkkj,cmbc,cibmb,bocmbankpsn,bankofbjpay,uppaynonghangcredit,uppayhuaxia,zytuppay,LZYHSJYHAUTHSSOAPP,bnbpay,dlrcb,czbank,uppayCbhb`填写进去
* step5Android/IOS打自定义基座包然后选择以自定义基座包运行
* step6harmonyOS执行完成准备工作`moudle.json5文件拷贝至harmony-configs -> entry -> src -> main目录下`
* step6.1`module.json5`路径:`unpackage -> dist -> dev -> app-harmony -> entry -> src -> main`
* step6.2:修改`module.json5`文件,新增以下代码
```javascript
"module": {
...
"pages": "$profile:main_pages",
"querySchemes": [
"uppaywallet",
"uppaysdk",
],
"abilities": [
{
...
"skills": [
{
...
"uris": [
{
"scheme": "uppaylyhuts",
}
]
}
]
}
]
}
```
* step7运行项目
#### 详细接入步骤及其他细则
1. 使用插件
* 1) 插件方法说明HX其实都有提示再赘述一遍吧别嫌我啰嗦哈
+ checkWalletInstalled() 检查是否安装云闪付App返回true或者false
+ startPay(object) 拉起云闪付app并发起支付具体说明见下
+ getDirectApps(function) 检查已安装的支持直通模式的银行app列表。`用途是在服务端生成tn时保留域传入"supportBank": "银行标识"``感谢用户cha***@126.com的修正`
---
> `startPay`方法说明
>
> 参数说明入参为object
>
> | 属性 | 类型 | 默认值 | 必填 | 说明 |
> | ------------ | ------------ | ------------ | ------------ | ------------ |
> |mode | string | 无 | 是 | 银联环境可选项00/0100正式环境01测试环境 |
> |tn | string | 无 | 是 | 服务端返回的交易流水号即tn |
> |seType | string | 无 | 否 | `【IOS无效】`手机pay支付类别传入会展示对应的手机支付华为支付就传04具体说明见`seType说明表` |
> |callback | function | 无 | 是 | 支付结果回调,回参为`object`,属性见`返回值说明` |
>
> 返回值说明
>
> | 属性 | 返回值说明 |
> | ------------ | ------------ |
> |code | 【必填】状态码0支付成功、1前台支付成功存在不确定性需要后端查询订单实际支付结果(基于data中的签名判断)、-1支付失败、-2支付取消 |
> |msg | 【必填】提示信息 |
> |data | 【选填】支付签名信息,只有`code=1`的时候返回 |
---
> `getDirectApps`方法说明
>
> 参数说明入参为function函数回参为`object`,属性见`返回值说明`
>
> 返回值说明
>
> | 属性 | 返回值说明 |
> | ------------ | ------------ |
> |code | 【必填】状态码。0请求成功、1请求失败(会将银联的错误code和错误msg都返回在data中组成一个对象) |
> |msg | 【必填】提示信息 |
> |data | 【必填】响应结果。code=0时为Array<string>对象,其中的值代表`直通银行标识`,详见`直通银行标识对照表`、code=1是为object对象是银联的错误对象 |
2. seType说明表`注意seType是string类型不是number`
| 手机品牌 | seType |
| ------------ | ------------ |
| Samsung Pay | 02 |
| Huawei Pay | 04 |
| Meizu Pay | 27 |
| Le Pay | 30 |
| Mi Pay | 25 |
| OPPO Pay | 29 |
| vivo Pay | 33 |
| Smartisan Pay | 32 |
| realme Pay | 35 |
3. 代码示例
```javascript
// uniapp项目引入方式
import { checkWalletInstalled, getDirectApps, startPay } from '../../uni_modules/liyahong-unionpay'
// uniappx项目引用方式注意uniappx项目必须使用@符号的方式引用,否则会报路径找不到的问题)
import { checkWalletInstalled, getDirectApps, startPay } from '@/uni_modules/liyahong-unionpay'
/**
* 检查是否安装云闪付App
*/
checkInstalled() {
const result = checkWalletInstalled()
this.installResult = `是否安装云闪付:${result}`
},
/**
* 【鸿蒙不支持此功能】获取直通银行App列表
*/
getBankAppList() {
getDirectApps((result) => {
console.log(JSON.stringify(result))
})
},
/**
* 拉起云闪付进行支付
*/
startPay() {
startPay({
tn: '',
mode: '00',
callback: (result) => {
console.log(JSON.stringify(result))
}
})
}
```
4. 直通银行标识对照表`服务端生成tn时使用举例supportBank:CQP`
| 银行标识 | 银行 APP 名称 |
| ------------ | ------------ |
| CQP | 云闪付 |
| CMBCC | 全民生活 |
| PAB | 平安口袋银行 |
| CCB | 中国建设银行 |
| BoCom | 交通银行 |
| ABC | 中国农业银行 |
| CMB | 招商银行 |
| CMBLIFE | 掌上生活 |
| ICBC | 中国工商银行 |
| SPDB | 浦发银行 |
| SPDBC | 浦大喜奔 |
| CNCB | 中信银行手机银行 |
| GDBC | 发现精彩 |
| CIBC | 兴业生活(好兴动) |
| HXBC | 华彩生活 |
| BCCBC | 掌上京彩 |
| BOCC | 中国银行缤纷生活 |
| CEBC | 阳光惠生活 |
| ICBCC | 工银 e 生活 |
| CCBC | 建行生活 |
| BoComC | 买单吧 |
| GDB | 广发银行手机银行 |
| PSBC | 邮储银行 |
| PSBCC | 邮储信用卡 |
| CEB | 光大银行手机银行 |
| BOS | 上海银行手机银行 |
| SHBANK | 上银美好生活 |
| CNCBC | 动卡空间 |
| CMBC | 民生银行手机银行 |
| CIB | 兴业银行手机银行 |
| BOC | 中国银行 |
| BCCB | 京彩生活 |
| ABCC | 农银 e 管家 |
| HXB | 华夏手机银行 |
5. iOS访问白名单对照表
| 支付 APP scheme | 对应支付 APP |
| ------------ | ------------ |
| uppaysdk | 云闪付 APP |
| uppaywallet | 云闪付 APP |
| uppayx1 | 全民生活 |
| uppayx2 | 预留 |
| uppayx3 | 预留 |
| paesuperbank | 平安口袋银行 |
| ccbmbsylunionpay | 中国建设银行 |
| bocom | 交通银行 |
| bankabc | 中国农业银行 |
| cmbmobilebank | 招商银行 |
| cmblife | 掌上生活 |
| com.icbc.iphoneclient | 中国工商银行 |
| spdbbank | 浦发银行 |
| spdbcccUnionPay | 浦大喜奔 |
| citicbankpay | 中信银行手机银行 |
| credit | 发现精彩 |
| uppayxingyecredit | 兴业生活(好兴动) |
| uppayhuaxiacredit | 华彩生活 |
| uppaybeijingcredit | 掌上京彩 |
| uppayzhonghangcredit | 中国银行缤纷生活 |
| uppayguangdacredit | 阳光惠生活 |
| uppaygonghangcredit | 工银 e 生活 |
| uppayjianhangcredit | 建行生活 |
| uppayjiaohangcredit | 买单吧 |
| uppayguangfa | 广发银行手机银行 |
| psbccashier | 邮储银行 |
| uppayyouchucredit | 邮储信用卡 |
| com.cebbank.ebank | 光大银行手机银行 |
| BankOfShangHai | 上海银行手机银行 |
| boscgdlf | 上银美好生活 |
| citicbankdkkj | 动卡空间 |
| cmbc | 民生银行手机银行 |
| cibmb | 兴业银行手机银行 |
| bocmbankpsn | 中国银行 |
| bankofbjpay | 京彩生活 |
| uppaynonghangcredit | 农银 e 管家 |
| uppayhuaxia | 华夏手机银行 |
| zytuppay | 中银通 |
| LZYHSJYHAUTHSSOAPP | 兰州银行 |
| bnbpay | 宁波银行 |
| dlrcb | 大连农商行 |
| czbank | 浙商银行 |
| uppayCbhb | 渤海银行 |
6. 其他附属
* 1) 银联测试卡链接:[测试卡直达](https://open.unionpay.com/tjweb/support/faq/mchlist?id=4)
* 2) 商户需按照以下链接及表格内容配置 IP 及地址白名单。[配置服务端白名单链接直达](https://open.unionpay.com/tjweb/support/faq/mchlist?id=228)
| 测试 | 生产 |
| ------------ | ------------ |
| https://appcashier.test.cup.com.cn | https://conf.cup.com.cn |
| https://appcashier.test.95516.com | https://conf.95516.com |
| | https://acpstatic.cup.com.cn |
| | https://acpstatic.95516.com |
| | https://appcashier.95516.com |
* 3) Apple Pay需要自行接入接入参考[链接直达](https://open.unionpay.com/tjweb/support/faq/mchlist?id=741)
* 4) 其他问题请参见 [https://open.unionpay.com](https://open.unionpay.com) 帮助中心-FAQ
7. 已知问题
* Q频繁调用`getDirectApps``startPay`函数会导致callback回调触发多次`感谢用户:[爱心]GLL`
* A多页面可以通过页面路径来判断是否是当前页面触发如果是再执行下一步操作否则拦截