## uni.requestPayment(options) @requestpayment uni.requestPayment是一个统一各平台的客户端支付API，客户端均使用本API调用支付。 本API运行在各端时，会自动转换为各端的原生支付调用API。 注意支付不仅仅需要客户端的开发，还需要服务端开发。虽然客户端API统一了，但各平台的支付申请开通、配置回填仍然需要看各个平台本身的支付文档。 比如微信有App支付的申请入口和使用流程，对应到uni-app，在App端要申请微信的App支付。 如果服务端使用[uniCloud](https://uniapp.dcloud.io/uniCloud/README)，那么官方提供了[uniPay](https://doc.dcloud.net.cn/uniCloud/uni-pay/uni-app.html)云端统一支付服务，把App、微信小程序、支付宝小程序里的服务端支付开发进行了统一的封装。 前端统一的`uni.requestPayment`和云端统一的`uniPay`搭配，可以极大提升支付业务的开发效率，强烈推荐给开发者使用。`uniPay`的文档另见：[https://doc.dcloud.net.cn/uniCloud/uni-pay/uni-app.html](https://doc.dcloud.net.cn/uniCloud/uni-pay/uni-app.html) ### orderInfo参数说明 - 支付宝支付 App 支付请求参数字符串，主要包含商家的订单信息，key=value 形式，以 & 连接。示例 ``` app_id=2015052600090779&biz_content=%7B%22timeout_express%22%3A%2230m%22%2C%22seller_id%22%3A%22%22%2C%22product_code% 22%3A%22QUICK_MSECURITY_PAY%22%2C%22total_amount%22%3A%220.02%22%2C%22subject%22%3A%221%22%2C%22body%22%3A%22%E6%88% 91%E6%98%AF%E6%B5%8B%E8%AF%95%E6%95%B0%E6%8D%AE%22 %2C%22out_trade_no%22%3A%22314VYGIAGG7ZOYY%22%7D&charset=utf-8&method=alipay.trade.app.pay&sign_type=R SA2×tamp=2016-08-15%2012%3A12%3A15&version=1.0&sign=MsbylYkCzlfYLy9PeRwUUIg9nZPeN9SfXPNavUCroGKR5Kqvx0nEnd3eRmKxJuthNUx4ERCXe552 EV9PfwexqW%2B1wbKOdYtDIb4%2B7PL3Pc94RZL0zKaWcaY3tSL89%2FuAVUsQuFqEJd hIukuKygrXucvejOUgTCfoUdwTi7z%2BZzQ%3D
``` [更多详情参考[支付宝官方文档](https://opendocs.alipay.com/open/204/105296?pathHash=22ed0058&ref=api)] - 微信支付 App 支付请求参数字符串,需要打自定义基座。示例 ```json { "appid":"wxd569c7238830733b", "noncestr":"6N47VnR42bqIm4xq", "package":"Sign=WXPay", "partnerid":"1230636401", "prepayid":"wx26174750316675ac54b89c224eb3250000", "timestamp":1711446470, "sign":"EE987459B9CFF6462462147130110D31" } ``` [更多详情参考[微信官方文档]( https://pay.weixin.qq.com/wiki/doc/api/wxa/wxa_api.php?chapter=9_1)] ### 支付provider对象描述 UniPaymentAlipayProvider(支付宝支付)继承自 [UniProvider](./provider.md#uniprovider) UniPaymentWxpayProvider(微信支付)继承自 [UniProvider](./provider.md#uniprovider)，特有字段说明： | 名称 | 类型 | 必备 | 默认值 | 描述 | | -------------- | --------- | ---- | ------ | ------------------------------------- | | isWeChatInstalled | boolean | 是 | - | 判断微信是否安装 | ### 支付SDK错误码 支付失败时可通过错误回调参数`IRequestPaymentFail`中的`cause`属性获取支付SDK的源错误信息，类型为[SourceError](https://uniapp.dcloud.net.cn/tutorial/err-spec.html#sourceerror)，其包含 code 属性存储了支付SDK的原始错误码。 #### 支付宝支付 | 支付宝错误码 | 错误信息 | |---|---| | -9000 | 订单支付成功 | | -8000 | 正在处理中，支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态 | | -4000 | 订单支付失败 | | -5000 | 重复请求 | | -6001 | 用户中途取消 | | -6002 | 网络连接出错 | | -6004 | 支付结果未知（有可能已经支付成功），请查询商家订单列表中订单的支付状态 | | 其它 | 其它支付错误 | #### 微信支付 | 微信支付错误码 | 错误信息 | |---|---| | 0 | 成功 | | -1 | 可能的原因：签名错误、未注册APPID、项目设置APPID不正确、注册的APPID与设置的不匹配、其他异常原因等 | | -2 | 无需处理。发生场景：用户不支付了，点击取消，返回APP | | -3 | 发送失败 | | -4 | 授权被拒绝 | | -5 | 不支持 | | -6 | 禁止 | | 其它 | 其它支付错误 | ### 注意 - App平台开发支付宝支付，无需自定义基座，真机运行可直接开发 - App平台判断微信是否安装可以通过`uni.getProvider`的方式，详见[uni.getProvider](https://doc.dcloud.net.cn/uni-app-x/api/provider.html#getprovider) ```ts uni.getProvider({ service: "payment", success: (e) => { const provider = e.providers.find((item): boolean => { return item.id == 'wxpay' }) // #ifdef APP-ANDROID if (provider != null && provider instanceof UniPaymentWxpayProvider && !((provider as UniPaymentWxpayProvider).isWeChatInstalled)) { console.log('WeChat 没有安装') } else { console.log('WeChat 已安装') } // #endif // #ifdef APP-IOS if (provider != null && ((provider as UniPaymentWxpayProvider).isWeChatInstalled == undefined || ((provider as UniPaymentWxpayProvider).isWeChatInstalled != null && (provider as UniPaymentWxpayProvider).isWeChatInstalled == false))) { console.log('WeChat 没有安装') } else { console.log('WeChat 已安装') } // #endif }, fail: (e) => { console.log("获取支付通道失败：", e); } }) ``` - **app需要在根目录manifest.json文件中配置`uni-payment`节点，详见 [https://doc.dcloud.net.cn/uni-app-x/collocation/manifest-modules.html#uni-payment模块配置](https://doc.dcloud.net.cn/uni-app-x/collocation/manifest-modules.html#uni-payment)** - app-android平台微信支付需要4.11及以上版本 - app-ios平台微信支付需要4.18及以上版本 ## API源码和更多SDK功能 App平台，微信和支付宝的SDK，除了requestPayment API封装的功能，还有一些其他功能。如开发者需要调用这些SDK的其他API，可以使用uts直接调用（注意打包时勾选相应的模块） 可以参考uni.requestPayment的源码，也是通过uts调用这2个原生SDK： - [支付宝](https://gitcode.net/dcloud/uni-api/-/tree/alpha/uni_modules/uni-payment-alipay) - [微信](https://gitcode.net/dcloud/uni-api/-/tree/alpha/uni_modules/uni-payment-wxpay) ## 自定义支付provider接入到uni API @customprovider 背景：目前uni-app x引擎已经内置了支付宝支付、微信支付。但支付SDK还有很多，比如银联SDK。 以往这些SDK可以通过独立插件的方式集成到uni-app x中，但需要提供单独的API给开发者使用。 uni-app x从4.25起，开放了provider自接入机制，让三方SDK可以以[provider](./provider.md)方式被开发者集成。 开发一个UTS插件，对接uni规范化的API、错误信息描述等实现自己的支付插件，这样插件使用者就可以通过uni的标准API使用三方SDK。 举个例子，开发者想使用uni.requestPayment()的方式调用XX支付，但是内置支付api不支持， 那只需要按照下面四个步骤实现即可: 第一步，新建一个UTS插件，在interface.uts 中定义接口，继承UniPaymentProvider，代码如下 ```ts export interface UniPaymentAlipayProvider extends UniPaymentProvider{} ``` 第二步，在app-android或者app-ios的index.uts中实现接口，代码如下 ```ts import { UniPaymentAlipayProvider } from '../interface.uts' export class UniPaymentAlipayProviderImpl implements UniPaymentAlipayProvider{ override id : String = "XX" // id必须有插件作者前缀，避免冲突，避免不同插件作者的插件id重名 override description : String = "XX的描述" override isAppExist : boolean | null = null constructor(){} override requestPayment(options : RequestPaymentOptions) { //todo 具体逻辑，接收uni规范的入参，进行业务处理，返回uni规范的返回值。如遇到错误，按uni的规范返回错误码 } } ``` 第三步，在manifest.json中配置 ```ts "app": { "distribute": { /* android打包配置 */ "modules": { "uni-payment":{ "XX":{} } } } } ``` 第四步，打包自定义基座然后运行 由于uni-app x内置的支付API也是基于这套规范实现的，所以推荐参考 [uni-app x支付宝支付插件的实现源码](https://gitcode.net/dcloud/uni-api/-/tree/alpha/uni_modules/uni-payment-alipay)