uniCloud

简介

引入 unipay

初始化

展示全部

本文档为uni-pay 1.x版本文档。适用于老项目。新项目请另行查阅 uni-pay 2.x 版本文档。

# 简介

unipay为uniCloud开发者提供了简单、易用、统一的支付能力封装。让开发者无需研究支付宝、微信等支付平台的后端开发、无需为它们编写不同代码，拿来即用，屏蔽差异。

uni-app前端已经封装的全端支付 api uni.requestPayment，现在服务端也封装好了unipay for uniCloud，从此开发者可以极快的完成前后一体的支付业务。

目前已封装 App 端（微信支付和支付宝支付）、微信小程序、支付宝小程序的支付能力。

unipay是开源 sdk，可放心使用。本插件还包含示例工程，配置自己在微信和支付宝申请的相关配置后即可运行。

为了更好的体验支付流程可以在插件市场导入unipay的示例项目快速体验，插件市场 unipay。gitee仓库 unipay公共模块。

插件市场还有基于uniPay再次封装的模板，前端支付、管理端订单管理均已写好，拿去就用，见：BaseCloud - 统一下单支付业务模块

须知

unipay 对入参和返回值均做了驼峰转化，开发者在对照微信支付或者支付宝支付对应的文档时需要注意。
特殊参数appId、mchId需注意大小写
所有金额被统一为以分为单位（避免浮点误差）
为避免无关参数干扰此文档仅列举必填参数，其余参数请参照微信支付-小程序、微信支付-App、支付宝支付-小程序、支付宝支付-App
微信支付沙箱环境不支持小程序支付，另外此沙箱环境只可以跑微信提供的测试用例不可以随意测试
无论是微信还是支付宝，沙箱环境都不确保稳定，如果使用沙箱的过程中遇到疑难问题建议切换成正式环境测试

问题排查指引

支付宝支付蚂蚁技术支持

# 引入 unipay

开发者可以自行选择是从插件市场导入还是从 npm 安装，引入方式略有不同，请看下面示例

// 插件市场导入
const unipay = require('uni-pay')

// npm安装
const unipay = require('@dcloudio/unipay')

注意

插件市场导入的用法请参考云函数公用模块

# 初始化

进行初始化操作返回 unipay 实例

# 微信支付V3

新增于 uni-pay 1.1.0

入参说明

参数名	类型	必填	默认值	说明
appId	String	是	-	当前应用在对应支付平台的 appId
mchId	String	是	-	商户号
v3Key	String	是	-	API v3 密钥
appCertPath	String	是	-	商户 API 证书文件路径（文件路径与字符串二选一）
appCertContent	String	是	-	商户 API 证书字符串（文件路径与字符串二选一）
appPrivateKeyPath	String	是	-	商户 API 私钥文件路径（文件路径与字符串二选一）
appPrivateKeyContent	String	是	-	商户 API 私钥字符串（文件路径与字符串二选一）
timeout	Number	否	5000	请求超时时间，单位：毫秒

const path = require('path'); // 引入内置的path模块

const unipayIns = unipay.initWeixinV3({
  appId: 'your appId',
  mchId: 'your mchId',
  v3Key: 'you parterner key',
  appCertPath: path.resolve(__dirname, 'your appCertPath'),
  // appCertContent: "",
  appPrivateKeyPath: path.resolve(__dirname, 'your appPrivateKeyPath'),
  // appPrivateKeyContent: "",
})

说明

证书字符串与私钥字符串格式要求：

证书字符串不应包含-----BEGIN CERTIFICATE----- 与 -----END CERTIFICATE-----，并且证书内容不能换行
私钥字符串不应包含-----BEGIN PRIVATE KEY----- 与 -----END PRIVATE KEY-----，并且私钥内容不能换行

例：

// 证书内容
-----BEGIN CERTIFICATE-----
your certificate content...
-----END CERTIFICATE-----

// 证书字符串
appCertContent = 'your certificate content...'

# 微信支付v2

入参说明

参数名	类型	必填	默认值	说明
appId	String	是	-	当前应用在对应支付平台的 appId
mchId	String	是	-	商户号
subAppId	String	否	-	子商户appId
subMchId	String	否	-	子商户号
key	String	是	-	支付商户 key （API密钥）
pfx	String\|Buffer	使用退款功能必填	-	微信支付商户 API 证书，主要用于退款
timeout	Number	否	5000	请求超时时间，单位：毫秒
signType	String	否	MD5	签名类型
sandbox	Boolean	否	false	是否启用沙箱环境

const unipayIns = unipay.initWeixin({
  appId: 'your appId',
  mchId: 'your mchId',
  key: 'you parterner key',
  pfx: fs.readFileSync('/path/to/your/pfxfile'), // 建议以p12文件绝对路径进行读取，使用微信退款时需要
})


// 以证书放在云函数index.js同级的cert目录下为例，index.js内可以按照下面这个写
const fs  = require('fs');
const path = require('path');
const unipayIns = unipay.initWeixin({
  appId: 'your appId',
  mchId: 'your mchId',
  key: 'you parterner key',
  pfx: fs.readFileSync(path.resolve(__dirname, 'cert/xxx.p12'))
})

# 支付宝支付

入参说明

参数名	类型	必填	默认值	说明
appId	String	是	-	当前应用在对应支付平台的 appId
mchId	String	是	-	商户号
privateKey	String	是	-	应用私钥字符串
alipayPublicKey	String	否	-	支付宝公钥，验签使用
keyType	String	否	PKCS8	应用私钥字符串类型
timeout	Number	否	5000	请求超时时间，单位：毫秒
signType	String	否	RSA2	签名类型
sandbox	Boolean	否	false	是否启用沙箱环境
alipayRootCertPath	String	否	-	`1.0.6+`，支付宝根证书文件路径
appCertPath	String	否	-	`1.0.6+`，应用公钥证书文件路径
alipayPublicCertPath	String	否	-	`1.0.6+`，支付宝公钥证书文件路径

const unipayIns = unipay.initAlipay({
  appId: 'your appId',
  mchId: 'your mchId',
  privateKey: 'your privateKey',
  // 如果不使用证书（普通公钥模式）需要alipayPublicKey
  alipayPublicKey: 'you alipayPublicKey', // 使用支付时需传递此值做返回结果验签
  // 如果使用证书需要传alipayRootCertPath、appCertPath、alipayPublicCertPath
  alipayRootCertPath: path.join(__dirname,'../fixtures/alipayRootCert.crt'),
  appCertPath: path.join(__dirname,'../fixtures/appCertPublicKey.crt'),
  alipayPublicCertPath: path.join(__dirname,'../fixtures/alipayCertPublicKey_RSA2.crt'),
})

常见问题

支付宝支付时遇到error:0D0680A8:asn1 encoding routines:ASN1_CHECK_TLEN:wrong tag类似的错误时请确认一下自己的私钥格式，如果不是PKCS8需要在初始化时传入keyType参数，值为对应的私钥格式

# 苹果内购支付

入参说明

参数名	类型	必填	默认值	说明
sandbox	Boolean	否	false	是否启用沙箱环境
password	String	否	-	App 专用共享密钥，App 专用共享密钥是用于接收此 App 自动续期订阅收据的唯一代码。如果您要将此 App 转让给其他开发者或不想公开主共享密钥，建议使用 App 专用共享密钥。非自动续订场景不需要此参数
timeout	Number	否	5000	请求超时时间，单位：毫秒

const unipayIns = unipay.initAppleIapPayment({
  sandbox: true,
  password: 'your password',
})

# 微信小程序虚拟支付

入参说明

参数名	类型	必填	默认值	说明
appId	String	是	-	微信小程序的appid
secret	String	是	-	微信小程序的secret
mchId	String	是	-	微信虚拟支付的商户id
offerId	String	是	-	微信虚拟支付的支付应用ID
appKey	String	是	-	微信虚拟支付的现网AppKey（正式环境）
sandboxAppKey	String	是	-	微信虚拟支付的沙箱AppKey
rate	Number	是	100	微信虚拟支付的代币兑换比例，比如1元兑换100代币，那么这里就是100（需要开通虚拟支付的时候也设置成 1 人民币 = 100 代币）
token	String	是	-	微信小程序通信的token，在开发 - 开发管理 - 消息推送 - Token(令牌)
encodingAESKey	String	是	-	微信小程序消息加密密钥，必须43位，在开发 - 开发管理 - 消息推送 - EncodingAESKey(消息加解密密钥)
accessToken	String	是	-	微信小程序的accessToken（注意此token有过期时间，需要自己做缓存）
sandbox	Boolean	否	false	是否启用沙箱环境

const unipayIns = unipay.initWeixinVirtualPayment({
	"appId": "", // 微信小程序的appid			
	"secret": "", // 微信小程序的secret					
	"mchId": "", // 商户id
	"offerId": "", // 支付应用ID
	"appKey": "", // 现网AppKey（正式环境）
	"sandboxAppKey": "", // 沙箱AppKey
	"rate": 100, // 代币兑换比例，比如1元兑换100代币，那么这里就是100（需要开通虚拟支付的时候也设置成 1 人民币 = 100 代币）
	"token": "", // 微信小程序通信的token，在开发 - 开发管理 - 消息推送 - Token(令牌)
	"encodingAESKey": "", // 必须43位，微信小程序消息加密密钥，在开发 - 开发管理 - 消息推送 - EncodingAESKey(消息加解密密钥)
	"accessToken": "", // 微信小程序的accessToken（注意此token有过期时间，需要自己做缓存）													
	"sandbox": false, // 是否是沙箱环境（注意：沙箱环境异步回调可能有延迟，建议直接正式环境测试）
})

# Api 列表

# 获取支付参数

unipayIns.getOrderInfo

入参说明

参数名	类型	必填	默认值	说明	支持平台
openid	String	支付宝小程序、微信小程序必填，App端支付不需要	-	通过对应 uni-id 接口进行获取，服务商模式应使用子商户获取的openid	支付宝小程序、微信小程序
subject	String	支付宝支付必填，微信支付时忽略此项	-	订单标题	支付宝支付
body	String	微信支付必填	-	商品描述	微信支付
outTradeNo	String	必填	-	商户订单号,有长度限制（微信支付为32字符以内，支付宝为64字符以内）、只能包含字母、数字、下划线；需保证在商户端不重复
totalFee	Number	必填	-	订单金额，单位：分	支付宝小程序、微信小程序
notifyUrl	String	必填	-	支付结果通知地址，需要注意支付宝支付时退款也会通知到此地址，务必处理好自己的业务逻辑
spbillCreateIp	String	必填	-	客户端IP，云函数内可以通过`context.CLIENTIP`获取	-
tradeType	String	是	-	交易类型；见下方 tradeType 的说明
sceneInfo	Object	微信tradeType为MWEB时必填	-	见下方sceneInfo的说明	-

注意

此接口支持直接传微信和支付宝官方文档上的参数，如微信的 support_fapiao 参数，转成驼峰 supportFapiao 即可

let	orderInfo = await unipayIns.getOrderInfo({
	...前面参数省略
	notifyUrl: 'https://xxx.xx', // 支付结果通知地址
	supportFapiao: true
})

tradeType的说明

tradeType支持以下选项

JSAPI 适用于：微信公众号支付、微信小程序支付、支付宝小程序支付
APP 适用于：支付宝、微信APP支付
NATIVE 适用于：支付宝、微信PC网站扫码支付
MWEB 适用于：微信h5（非公众号）跳转微信页面支付（新增于uni-pay 1.0.24）

sceneInfo的说明

微信支付tradeType为MWEB时需要传递以下格式的sceneInfo

{
	"h5Info": {
		"type": "Wap",
		"wapUrl": "https://pay.qq.com", // 开发者网站的网址
		"wapName": "腾讯充值" // 开发者网站名称
	}
}

返回值说明

参数名	类型	说明	支持平台
orderInfo	Object	String	客户端支付所需参数，直接返回给客户端即可，下面会介绍如何搭配客户端使用

使用示例

tradeType为NATIVE时直接将orderInfo.codeUrl转为二维码使用对应的客户端扫码支付即可

tradeType为MWEB时直接跳转到orderInfo.mwebUrl进行支付即可

// 云函数 - getOrderInfo
exports.main = async function (event,context) {
	let	orderInfo = await unipayIns.getOrderInfo({
		openid: 'user openid',
		subject: '订单标题', // 微信支付时不可填写此项
		body: '商品描述',
		outTradeNo: '商户订单号',
		totalFee: 1, // 金额，单位分
		notifyUrl: 'https://xxx.xx' // 支付结果通知地址
	})
	return {
		orderInfo
	}
}

// 客户端
uniCloud.callFunction({
	name: 'getOrderInfo',
	success(res) {
		uni.requestPayment({
			// #ifdef APP-PLUS
			provider: selectedProvider, // App端此参数必填，可以通过uni.getProvider获取
			// #endif
			// #ifdef MP-WEIXIN
			...res.result.orderInfo,
			// #endif
			// #ifdef APP-PLUS || MP-ALIPAY
			orderInfo: res.result.orderInfo,
			// #endif
			...res.result.orderInfo
			success(){},
			fail(){}
		})
	}
})

// 二维码支付
uniCloud.callFunction({
	name: 'getOrderInfo',
	success(res) {
    // 以二维码形式展示此内容
		console.log(res.result.orderInfo.codeurl)
	}
})

# 查询订单

unipayIns.orderQuery, 根据商户订单号或者平台订单号查询订单信息，主要用于未接收到支付通知时可以使用此接口进行支付结果验证

入参说明

参数名	类型	必填	默认值	说明	支持平台
outTradeNo	String	和 transactionId 二选一	-	商户订单号	-
transactionId	String	和 outTradeNo 二选一	-	平台订单号	-

返回值说明

参数名	类型	说明	支持平台
appId	String	平台分配的应用 ID	微信支付
mchId	String	商户号，（微信支付文档里面叫商户号：mch_id，支付宝支付叫卖家id：seller_id）	微信支付
outTradeNo	String	商户订单号	-
transactionId	String	平台订单号	-
tradeState	String	订单状态，见下方订单状态说明
totalFee	Number	标价金额，单位：分	-
settlementTotalFee	Number	应结订单金额，单位：分	支付宝支付
cashFee	Number	现金支付金额，单位：分	-

订单状态

微信支付： SUCCESS—支付成功 REFUND—转入退款 NOTPAY—未支付 CLOSED—已关闭 REVOKED—已撤销（刷卡支付） USERPAYING--用户支付中 PAYERROR--支付失败(其他原因，如银行返回失败)。

支付宝支付： USERPAYING（交易创建，等待买家付款） CLOSED（未付款交易超时关闭，或支付完成后全额退款） SUCCESS（交易支付成功） FINISHED（交易结束，不可退款）

使用示例

exports.main = async function (event) {
  let res = await unipayIns.orderQuery({
    outTradeNo: 'outTradeNo',
  })
  return res
}

# 关闭订单

unipayIns.closeOrder，用于交易创建后，用户在一定时间内未进行支付，可调用该接口直接将未付款的交易进行关闭，避免重复支付。

注意

微信支付：订单生成后不能马上调用关单接口，最短调用时间间隔为 5 分钟。

入参说明

参数名	类型	必填	默认值	说明	支持平台
outTradeNo	String	使用微信时必填，使用支付宝时和 transactionId 二选一	-	商户订单号	-
transactionId	String	使用支付宝时和 outTradeNo 二选一	-	平台订单号	支付宝支付

返回值说明

参数名	类型	说明	支持平台
appId	String	平台分配的应用 ID	微信支付V2
mchId	String	商户号	微信支付V2
outTradeNo	String	商户订单号	支付宝支付
transactionId	String	平台订单号	支付宝支付

使用示例

exports.main = async function (event) {
  let res = await unipayIns.closeOrder({
    outTradeNo: 'outTradeNo',
  })
  return res
}

# 撤销订单

unipayIns.cancelOrder，此接口仅支付宝支持，支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，支付宝系统会将此订单关闭；如果用户支付成功，支付宝系统会将此订单资金退还给用户。注意：只有发生支付系统超时或者支付结果未知时可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款 API。提交支付交易后调用【查询订单 API】，没有明确的支付结果再调用【撤销订单 API】。

入参说明

参数名	类型	必填	默认值	说明	支持平台
outTradeNo	String	和 transactionId 二选一	-	商户订单号	支付宝支付
transactionId	String	和 outTradeNo 二选一	-	平台订单号	支付宝支付

返回值说明

参数名	类型	说明	支持平台
outTradeNo	String	商户订单号	支付宝支付
transactionId	String	平台订单号	支付宝支付

使用示例

exports.main = async function (event) {
  let res = await unipayIns.cancelOrder({
    outTradeNo: 'outTradeNo',
  })
  return res
}

# 申请退款

unipayIns.refund,当交易发生之后一段时间内，由于买家或者卖家的原因需要退款时，卖家可以通过退款接口将支付款退还给买家。

微信支付注意事项

交易时间超过一年的订单无法提交退款
微信支付退款支持单笔交易分多次退款，多次退款需要提交原支付订单的商户订单号和设置不同的退款单号。申请退款总金额不能超过订单金额。一笔退款失败后重新提交，请不要更换退款单号，请使用原商户退款单号
请求频率限制：150qps，即每秒钟正常的申请退款请求次数不超过 150 次，错误或无效请求频率限制：6qps，即每秒钟异常或错误的退款申请请求不超过 6 次
每个支付订单的部分退款次数不能超过 50 次
如果同一个用户有多笔退款，建议分不同批次进行退款，避免并发退款导致退款失败

入参说明

参数名	类型	必填	默认值	说明	支持平台
outTradeNo	String	和 transactionId 二选一	-	商户订单号	-
transactionId	String	和 outTradeNo 二选一	-	平台订单号	-
outRefundNo	String	微信支付必填，支付宝支付选填	-	商户退款单号	-
totalFee	Number	微信支付必填	-	订单总金额	-
refundFee	Number	必填	-	退款总金额	微信支付
refundFeeType	String	微信支付V3必填	-	货币种类	微信支付V3
refundDesc	String	选填	-	退款原因	-
notifyUrl	String	微信支付选填，支付宝不支持	-	退款通知 url，支付宝会通知获取支付参数时的通知地址	微信支付

返回值说明

参数名	类型	说明	支持平台
outTradeNo	String	商户订单号	-
transactionId	String	平台订单号	-
outRefundNo	String	商户退款单号	微信支付
refundId	String	平台退款单号	-
refundFee	Number	退款总金额	-
cashRefundFee	Number	现金退款金额	-

使用示例

exports.main = async function (event) {
  let res = await unipayIns.refund({
    outTradeNo: '商户订单号',
    outRefundNo: '商户退款单号', // 支付宝可不填此项
    totalFee: 1, // 订单总金额，支付宝可不填此项
    refundFee: 1, // 退款总金额
  })
  return res
}

# 查询退款

unipayIns.refundQuery，提交退款申请后，通过调用该接口查询退款状态。

入参说明

参数名	类型	必填	默认值	说明	支持平台
outTradeNo	String	微信支付V2四选一，支付宝和 transactionId 二选一	-	商户订单号	-
transactionId	String	微信支付V2四选一，支付宝和 outTradeNo 二选一	-	平台订单号	-
outRefundNo	String	微信支付V3必填，微信支付V2四选一，支付宝必填	-	商户退款单号	-
refundId	String	微信支付V2四选一	-	平台退款单号	微信支付
offset	Number	微信支付V2选填	-	偏移量，当部分退款次数超过 10 次时可使用，表示返回的查询结果从这个偏移量开始取记录	-

注意

outRefundNo为使用支付宝请求退款接口时，传入的商户退款单号。如果在退款请求时未传入，则该值为创建交易时的商户订单号即outTradeNo

返回值说明

参数名	类型	说明	支持平台
outTradeNo	String	商户订单号	-
transactionId	String	平台订单号	-
totalFee	Number	订单金额	-
refundId	String	平台退款单号，仅支付宝、微信支付V3返回	-
refundFee	Number	退款总金额	-
refundDesc	String	退款理由	-
refundList	Array<refundItem>	分笔退款信息，仅微信支付V2返回	微信支付V2
refundRoyaltys	Array<refundRoyaltysItem>	退分账明细信息，仅支付宝返回	支付宝支付

refundItem 说明

参数名	类型	说明	支持平台
outRefundNo	String	商户退款单号	-
refundId	String	平台退款单号	-
refundChannel	String	退款渠道，ORIGINAL—原路退款，BALANCE—退回到余额，OTHER_BALANCE—原账户异常退到其他余额账户，OTHER_BANKCARD—原银行卡异常退到其他银行卡
refundFee	Number	申请退款金额	-
settlementRefundFee	Number	退款金额,退款金额=申请退款金额-非充值代金券退款金额，退款金额<=申请退款金额
refundStatus	String	退款状态，SUCCESS—退款成功，REFUNDCLOSE—退款关闭，PROCESSING—退款处理中，CHANGE—退款异常，退款到银行发现用户的卡作废或者冻结了，导致原路退款银行卡失败，可前往商户平台（pay.weixin.qq.com）-交易中心，手动处理此笔退款。
couponRefundFee	Number	总代金券退款金额	-
couponRefundCount	Number	退款代金券使用数量	-
refundAccount	String	退款资金来源	-
refundRecvAccout	String	退款入账账户	-
refundSuccessTime	String	退款成功时间	-
couponList	Array<couponItem>	分笔退款信息	-

couponItem 说明

参数名	类型	说明	支持平台
couponType	String	代金券类型	-
couponRefundId	String	退款代金券 ID	-
couponRefundFee	String	单个代金券退款金额	-

refundRoyaltysItem 说明

参数名	类型	说明	支持平台
fundChannel	String	交易使用的资金渠道	-
bankCode	String	银行卡支付时的银行代码	-
amount	Number	该支付工具类型所使用的金额	-
realAmount	Number	渠道实际付款金额	-
fundType	String	渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信息(DEBIT_CARD:借记卡,CREDIT_CARD:信用卡,MIXED_CARD:借贷合一卡)	-

使用示例

exports.main = async function (event) {
  let res = await unipayIns.refundQuery({
    outTradeNo: '商户订单号',
    outRefundNo: '商户退款单号', // 支付宝必填
  })
  return res
}

# 下载交易账单

unipayIns.downloadBill，商户可以通过该接口下载历史交易清单。仅微信支付支持

注意：

微信侧未成功下单的交易不会出现在对账单中。支付成功后撤销的交易会出现在对账单中，跟原支付单订单号一致；
微信在次日 9 点启动生成前一天的对账单，建议商户 10 点后再获取；
对账单中涉及金额的字段单位为“元”。
对账单接口只能下载三个月以内的账单。
对账单是以商户号纬度来生成的，如一个商户号与多个 appid 有绑定关系，则使用其中任何一个 appid 都可以请求下载对账单。对账单中的 appid 取自交易时候提交的 appid，与请求下载对账单时使用的 appid 无关。

入参说明

参数名	类型	必填	默认值	说明	支持平台
billDate	String	必填	-	下载对账单的日期，格式：2014-06-03	-
billType	String	选填	ALL	ALL（默认值），返回当日所有订单信息（不含充值退款订单）,SUCCESS，返回当日成功支付的订单（不含充值退款订单）,REFUND，返回当日退款订单（不含充值退款订单）,RECHARGE_REFUND，返回当日充值退款订单	-

返回值说明

参数名	类型	说明	支持平台
content	String	文本表格的方式返回的数据	-

content示例如下

当日所有订单 交易时间,公众账号 ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,微信退款单号,商户退款单号,退款金额, 代金券或立减优惠退款金额，退款类型，退款状态,商品名称,商户数据包,手续费,费率

当日成功支付的订单 交易时间,公众账号 ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额, 代金券或立减优惠金额,商品名称,商户数据包,手续费,费率

当日退款的订单 交易时间,公众账号 ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额, 代金券或立减优惠金额,退款申请时间,退款成功时间,微信退款单号,商户退款单号,退款金额, 代金券或立减优惠退款金额,退款类型,退款状态,商品名称,商户数据包,手续费,费率

从第二行起，为数据记录，各参数以逗号分隔，参数前增加`符号，为标准键盘 1 左边键的字符，字段顺序与表头一致。

倒数第二行为订单统计标题，最后一行为统计数据

总交易单数，总交易额，总退款金额，总代金券或立减优惠退款金额，手续费总金额

举例如下：

交易时间,公众账号ID,商户号,子商户号,设备号,微信订单号,商户订单号,用户标识,交易类型,交易状态,付款银行,货币种类,总金额,代金券或立减优惠金额,微信退款单号,商户退款单号,退款金额,代金券或立减优惠退款金额,退款类型,退款状态,商品名称,商户数据包,手续费,费率
`2014-11-10 16：33：45,`wx2421b1c4370ec43b,`10000100,`0,`1000,`1001690740201411100005734289,`1415640626,`085e9858e3ba5186aafcbaed1,`MICROPAY,`SUCCESS,`OTHERS,`CNY,`0.01,`0.0,`0,`0,`0,`0,`,`,`被扫支付测试,`订单额外描述,`0,`0.60%
`2014-11-10 16：46：14,`wx2421b1c4370ec43b,`10000100,`0,`1000,`1002780740201411100005729794,`1415635270,`085e9858e90ca40c0b5aee463,`MICROPAY,`SUCCESS,`OTHERS,`CNY,`0.01,`0.0,`0,`0,`0,`0,`,`,`被扫支付测试,`订单额外描述,`0,`0.60%
总交易单数,总交易额,总退款金额,总代金券或立减优惠退款金额,手续费总金额
`2,`0.02,`0.0,`0.0,`0

使用示例

exports.main = async function (event) {
  let res = await unipayIns.downloadBill({
    billDate: '20200202',
  })
  return res
}

# 下载资金账单

unipayIns.downloadFundflow,商户可以通过该接口下载自 2017 年 6 月 1 日起的历史资金流水账单。仅微信支持

说明：

资金账单中的数据反映的是商户微信账户资金变动情况；
当日账单在次日上午 9 点开始生成，建议商户在上午 10 点以后获取；
资金账单中涉及金额的字段单位为“元”。

入参说明

参数名	类型	必填	默认值	说明	支持平台
billDate	String	必填	-	下载对账单的日期，格式：2014-06-03	-
accountType	String	选填	Basic	账单的资金来源账户：Basic 基本账户，Operation 运营账户，Fees 手续费账户	-

返回值说明

参数名	类型	说明	支持平台
content	String	文本表格的方式返回的数据	-

content示例如下

第一行为表头

记账时间,微信支付业务单号,资金流水单号,业务名称,业务类型,收支类型,收支金额（元）,账户结余（元）,资金变更提交申请人,备注,业务凭证号

从第二行起，为资金流水数据，各参数以逗号分隔，参数前增加`符号，为标准键盘 1 左边键的字符，字段顺序与表头一致
倒数第二行为资金账单统计标题

资金流水总笔数,收入笔数,收入金额,支出笔数,支出金额

最后一行为统计数据

账单示例如下：

记账时间,微信支付业务单号,资金流水单号,业务名称,业务类型,收支类型,收支金额（元）,账户结余（元）,资金变更提交申请人,备注,业务凭证号

`2018-02-01 04:21:23,`50000305742018020103387128253,`1900009231201802015884652186,`退款,`退款,`支出,`0.02,`0.17,`system,`缺货,`REF4200000068201801293084726067

资金流水总笔数,收入笔数,收入金额,支出笔数,支出金额

`20.0,`17.0,`0.35,`3.0,`0.18

使用示例

exports.main = async function (event) {
  let res = await unipayIns.downloadFundflow({
    billDate: '20200202',
  })
  return res
}

# 支付结果通知处理

注意：支付宝在非全量退款时也会发送通知到支付时设置的notify_url

unipayIns.verifyPaymentNotify，用于在使用云函数 Url 化的云函数内检验并处理支付结果。

入参说明

只接收对应云函数的event作为参数

返回值说明

参数名	类型	说明	支持平台
totalFee	Number	订单总金额	-
cashFee	Number	现金支付金额	-
feeType	String	货币类别	-
outTradeNo	String	商户订单号	-
transactionId	String	平台订单号	-
timeEnd	String	支付完成时间，格式为 yyyyMMddHHmmss	-
openid	String	用户 id	-
returnCode	String	值 SUCCESS 时为支付成功，通常需要校验订单金额等参数	-

使用示例

exports.main = async function (event) {
  let res = await unipayIns.verifyPaymentNotify(event)
  // 处理完毕其他业务
  // 注意如果处理成功需要严格按照下面的格式进行返回，否则厂商会持续通知
  // 微信支付V3处理成功之后
  return {
    mpserverlessComposedResponse: true,
    statusCode: 200,
    headers: {
      'content-type': 'application/json'
    },
    body: JSON.stringify({
        code: 'SUCCESS',
        message: '成功'
    })
  }
  // 微信支付V2处理成功之后
  return {
    mpserverlessComposedResponse: true,
    statusCode: 200,
    headers: {
      'content-type': 'text/xml;charset=utf-8'
    },
    body: `<xml><return_code><![CDATA[SUCCESS]]></return_code><return_msg><![CDATA[OK]]></return_msg></xml>`
  }
  // 支付宝处理成功后
  return {
    mpserverlessComposedResponse: true,
    statusCode: 200,
    headers: {
      'content-type': 'text/plain'
    },
    body: "success"
  }
}

# 退款结果通知

注意：支付宝在非全量退款时才会发送通知，通知地址为支付时设置的notify_url

uni-pay 1.0.17版本起新增对支付宝退款结果通知的支持

unipayIns.verifyRefundNotify，用于在使用云函数 Url 化的云函数内检验并处理支付结果。

入参说明

只接收对应云函数的event作为参数

返回值说明

参数名	类型	说明	支持平台
totalFee	Number	订单总金额	-
refundFee	Number	申请退款金额	-
settlementTotalFee	Number	应结订单金额，支付宝不返回	-
settlementRefundFee	Number	退款金额，支付宝不返回	-
outTradeNo	String	商户订单号	-
transactionId	String	平台订单号	-
refundId	String	平台退款单号，支付宝不返回	-
outRefundNo	String	商户退款单号	-
refundStatus	String	SUCCESS-退款成功,CHANGE-退款异常,REFUNDCLOSE—退款关闭	-
refundAccount	String	退款资金来源，支付宝不返回	-
refundRecvAccout	String	退款入账账户，支付宝不返回	-

使用示例

exports.main = async function (event) {
  let res = await unipayIns.verifyRefundNotify(event)
  // 注意如果处理成功需要严格按照下面的格式进行返回，否则厂商会持续通知
  // 微信处理成功之后
  return {
    mpserverlessComposedResponse: true,
    statusCode: 200,
    headers: {
        'content-type': 'text/xml;charset=utf-8'
    },
    body: `<xml><return_code><![CDATA[SUCCESS]]></return_code><return_msg><![CDATA[OK]]></return_msg></xml>`
  }
  // 支付宝处理成功后
  return {
    mpserverlessComposedResponse: true,
    statusCode: 200,
    headers: {
      'content-type': 'text/plain'
    },
    body: "success"
  }
}

# 获取通知类型

新增于 uni-id 1.0.17

unipayIns.checkNotifyType，用于在使用云函数 Url 化的云函数内检验当前通知的类型。由于支付宝支付在非全量退款时会调用支付时设置的notify_url，可以使用此接口在调用校验通知之前判断通知类型

入参说明

只接收对应云函数的event作为参数

返回值说明

此接口会返回一个字符串，可能的值如下

refund：当前是一个退款通知
payment：当前是一个支付结果通知

使用示例

exports.main = async function (event) {
  let res = await unipayIns.checkNotifyType(event)
  if(res === 'refund') {
    // 退款通知
  } else if(res === 'payment') {
    // 支付结果通知
  }
}

# 苹果内购-校验支付凭证

unipayIns.verifyReceipt, 校验iap支付凭证返回交易信息。

入参说明

参数名	类型	必填	默认值	说明	支持平台
receiptData	String	是	-	支付凭证	苹果内购支付

返回值说明

参数名	类型	说明	支持平台
transactionId	String	交易标示	-
tradeState	String	订单状态，微信支付： SUCCESS—支付成功，REFUND—转入退款，NOTPAY—未支付，PAYERROR--支付失败(其他原因，如银行返回失败)，SUCCESS（交易支付成功）。	-
totalFee	Number	标价金额，单位：分	-
settlementTotalFee	Number	应结订单金额，单位：分	-
receipt	Object	收据信息	-

使用示例

exports.main = async function (event) {
  let res = await unipayIns.verifyReceipt({
    receiptData: 'transactionReceipt',
  })
  return res
}

# 微信小程序虚拟支付

前往微信小程序虚拟支付API文档

运营产品

uni-AD uni统计 uni发行 uni安全专题

开发者服务

问答社区开发者后台

技术文档

uni-app文档 uniCloud文档原生开发者支持文档 HBuilder文档

生态服务

插件市场 OAuth用户开放平台

关于我们： DCloud官网案例需求墙许可协议加入我们赞助我们

联系我们：商务合作：bd@dcloud.io 广告合作：uniad@dcloud.io

DCloud.io 数字天堂（北京）网络技术有限公司是

HTML5中国产业联盟发起单位

京公网安备：11010802035340号

国家信息安全等级保护三级，证书编号：11010813802-20001

# 简介

# 引入 unipay

# 初始化

# 微信支付V3

# 微信支付v2

# 支付宝支付

# 苹果内购支付

# 微信小程序虚拟支付

# Api 列表

# 获取支付参数

# 查询订单

# 关闭订单

# 撤销订单

# 申请退款

# 查询退款

# 下载交易账单

# 下载资金账单

# 支付结果通知处理

# 退款结果通知

# 获取通知类型

# 苹果内购-校验支付凭证

# 微信小程序虚拟支付

本页导读