微信小程序云开发SDK文档 微信支付·统一下单
CloudPay.unifiedOrder()
支持端：云函数 2.0.2
统一下单
说明
商户在小程序中先调用该接口在微信支付服务后台生成预支付交易单，返回正确的预支付交易后调起支付。
关键参数说明
云开发相关关键参数说明： 回调函数设置：envId 和 functionName 用来设置接收支付后的异步通知回调的云函数 返回字段 payment：该对象即是在小程序端调用 wx.requestPayment 所需的信息
回调云函数返回协议
支付结果回调的云函数必须返回如下一个对象，否则会视为回调不成功，云函数会收到重复的支付回调：
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 错误码 | errcode | 是 | Number | 0 |
| 错误信息 | errmsg | 是 | String |
参数说明
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 结果通知回调云函数名 | functionName | 是 | String | paycallback | 接收微信支付异步通知回调的云函数名 |
| 结果通知回调云函数环境 | envId | 是 | String | test-123 | 接收微信支付异步通知回调的云函数所在的环境 ID |
| 子商户号 | subMchId | 是 | String(32) | 1900000109 | 微信支付分配的子商户号 |
| 设备号 | deviceInfo | 否 | String(32) | 013467007045764 | 终端设备号(门店号或收银设备ID)，注意：PC网页或公众号内支付请传"WEB" |
| 随机字符串 | nonceStr | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于32位。推荐随机数生成算法 |
| 商品描述 | body | 是 | String(128) | 腾讯充值中心-QQ会员充值 | 商品简单描述，该字段须严格按照规范传递，具体请见参数规定 |
| 商品详情 | detail | 否 | String(6000) | 商品详细描述，对于使用单品优惠的商户，该字段必须按照规范上传，详见“单品优惠参数说明” | |
| 附加数据 | attach | 否 | String(127) | 说明 | 附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据 |
| 商户订单号 | outTradeNo | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部订单号，要求32个字符内，只能是数字、大小写字母_- |
| 货币类型 | feeType | 否 | String(16) | CNY | 符合ISO 4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型 |
| 总金额 | totalFee | 是 | Int | 888 | 订单总金额，只能为整数，详见支付金额 |
| 终端IP | spbillCreateIp | 是 | String(64) | 123.12.12.123 | 支持IPV4和IPV6两种格式的IP地址。调用微信支付API的机器IP |
| 交易起始时间 | timeStart | 否 | String(14) | 20091225091010 | 订单生成时间，格式为yyyyMMddHHmmss，如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
| 交易结束时间 | timeExpire | 否 | String(14) | 20091227091010 | 订单失效时间，格式为yyyyMMddHHmmss，如2009年12月27日9点10分10秒表示为20091227091010。订单失效时间是针对订单号而言的，由于在请求支付的时候有一个必传参数prepay_id只有两小时的有效期，所以在重入时间超过2小时的时候需要重新请求下单接口获取新的prepay_id。其他详见时间规则。 建议：最短失效时间间隔大于1分钟 |
| 订单优惠标记 | goodsTag | 否 | String(32) | WXG | 订单优惠标记，代金券或立减优惠功能的参数，说明详见代金券或立减优惠 |
| 交易类型 | tradeType | 是 | String(16) | JSAPI | 小程序取值如下：JSAPI，详细说明见参数规定 |
| 指定支付方式 | limitPay | 否 | String(32) | no_credit | no_credit--指定不能使用信用卡支付 |
| 用户标识 | openid | 否 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | trade_type=JSAPI，此参数必传，用户在商户appid下的唯一标识。openid如何获取，可参考【获取openid】。 |
| 用户子标识 | subOpenid | 否 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | trade_type=JSAPI，此参数必传，用户在子商户appid下的唯一标识。openid和sub_openid可以选传其中之一，如果选择传sub_openid,则必须传sub_appid。下单前需要调用【网页授权获取用户信息】接口获取到用户的Openid。 |
| 电子发票入口开放标识 | receipt | 否 | String(8) | Y | Y，传入Y时，支付成功消息和支付详情页将出现开票入口。需要在微信支付商户平台或微信公众平台开通电子发票功能，传此字段才可生效 |
| 场景信息 | sceneInfo | 否 | String(256) | Y | 该字段常用于线下活动时的场景信息上报，支持上报实际门店信息，商户也可以按需求自己上报相关信息。该字段为JSON对象数据，对象格式为{"store_info":{"id": "门店ID","name": "名称","area_code": "编码","address": "地址" }} |
sceneInfo.storeInfo 对象说明*
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 门店id | id | 否 | String(32) | SZTX001 | 门店编号，由商户自定义 |
| 门店名称 | name | 否 | String(64) | 腾讯大厦腾大餐厅 | 门店名称 ，由商户自定义 |
| 门店行政区划码 | area_code | 否 | String(6) | 440305 | 门店所在地行政区划码，详细见《最新县及县以上行政区划代码》 |
| 门店详细地址 | address | 否 | String(128) | 科技园中一路腾讯大厦 | 门店详细地址 ，由商户自定义 |
返回值说明
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | returnCode | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断 |
| 返回信息 | returnMsg | 否 | String(128) | 签名失败 | 返回信息，如非空，为错误原因。如 签名失败、参数格式校验错误 |
以下字段在returnCode为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 小程序中发起支付所需信息 | payment | 是 | Object | 小程序端调用 wx.requestPayment 所需信息 | |
| 服务商的APPID | appid | 是 | String(32) | wxd678efh567hg6787 | 服务商商户的APPID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 调用接口提交的商户号 |
| 小程序的APPID | sub_appid | 是 | String(32) | wx8888888888888888 | 微信分配的小程序ID |
| 子商户号 | sub_mch_id | 是 | String(32) | 1900000109 | 微信支付分配的子商户号 |
| 设备号 | device_info | 否 | String(32) | 013467007045764 | 调用接口提交的终端设备号， |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的随机字符串 |
| 签名 | sign | 是 | String(64) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的签名，详见签名算法 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 错误代码 | err_code | 否 | String(32) | SYSTEMERROR | 详细参见第6节错误列表 |
| 错误代码描述 | err_code_des | 否 | String(128) | 系统错误 | 错误返回的信息描述 |
以下字段在returnCode 和result_code都为SUCCESS的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 交易类型 | trade_type | 是 | String(16) | JSAPI | 调用接口提交的交易类型，取值如下：JSAPI，详细说明见参数规定 |
| 预支付交易会话标识 | prepay_id | 是 | String(64) | wx201410272009395522657a690389285100 | 微信生成的预支付回话标识，用于后续接口调用中使用，该值有效期为2小时 |
| 二维码链接 | code_url | 否 | String(64) | weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 | trade_type=NATIVE时有返回，此url用于生成支付二维码，然后提供给用户进行扫码支付。注意：code_url的值并非固定，使用时按照URL格式转成二维码即可 |
错误码
| 名称 | 描述 | 原因 | 解决方案 |
|---|---|---|---|
| INVALID_REQUEST | 参数错误 | 参数格式有误或者未按规则上传 | 订单重入时，要求参数值与原请求一致，请确认参数问题 |
| NOAUTH | 商户无此接口权限 | 商户未开通此接口权限 | 请商户前往申请此接口权限 |
| NOTENOUGH | 余额不足 | 用户帐号余额不足 | 用户帐号余额不足，请用户充值或更换支付卡后再支付 |
| ORDERPAID | 商户订单已支付 | 商户订单已支付，无需重复操作 | 商户订单已支付，无需更多操作 |
| ORDERCLOSED | 订单已关闭 | 当前订单已关闭，无法支付 | 当前订单已关闭，请重新下单 |
| SYSTEMERROR | 系统错误 | 系统超时 | 系统异常，请用相同参数重新调用 |
| APPID_NOT_EXIST | APPID不存在 | 参数中缺少APPID | 请检查APPID是否正确 |
| MCHID_NOT_EXIST | MCHID不存在 | 参数中缺少MCHID | 请检查MCHID是否正确 |
| APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 请确认appid和mch_id是否匹配 |
| LACK_PARAMS | 缺少参数 | 缺少必要的请求参数 | 请检查参数是否齐全 |
| OUT_TRADE_NO_USED | 商户订单号重复 | 同一笔交易不能多次提交 | 请核实商户订单号是否重复提交 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| XML_FORMAT_ERROR | XML格式错误 | XML格式错误 | 请检查XML参数格式是否正确 |
| REQUIRE_POST_METHOD | 请使用post方法 | 未使用post传递参数 | 请检查请求参数是否通过post方法提交 |
| POST_DATA_EMPTY | post数据为空 | post数据不能为空 | 请检查post数据是否为空 |
| NOT_UTF8 | 编码格式错误 | 未使用指定编码格式 | 请使用UTF-8编码格式 |
示例代码
// 云函数代码
const cloud = require('wx-server-sdk')
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
exports.main = async (event, context) => {
const res = await cloud.cloudPay.unifiedOrder({
"body" : "小秋TIT店-超市",
"outTradeNo" : "1217752501201407033233368018",
"spbillCreateIp" : "127.0.0.1",
"subMchId" : "1900009231",
"totalFee" : 1,
"envId": "test-f0b102",
"functionName": "pay_cb"
})
return res
}
// 小程序代码
wx.cloud.callFunction({
name: '函数名',
data: {
// ...
},
success: res => {
const payment = res.result.payment
wx.requestPayment({
...payment,
success (res) {
console.log('pay success', res)
},
fail (res) {
console.error('pay fail', err)
}
})
},
fail: console.error,
})