微信小程序云開發(fā)SDK文檔 微信支付·統(tǒng)一下單

2022-05-12 16:36 更新

CloudPay.unifiedOrder()

支持端:云函數(shù) 2.0.2

統(tǒng)一下單

說明

商戶在小程序中先調(diào)用該接口在微信支付服務(wù)后臺(tái)生成預(yù)支付交易單,返回正確的預(yù)支付交易后調(diào)起支付。

關(guān)鍵參數(shù)說明

云開發(fā)相關(guān)關(guān)鍵參數(shù)說明: 回調(diào)函數(shù)設(shè)置:envId 和 functionName 用來設(shè)置接收支付后的異步通知回調(diào)的云函數(shù) 返回字段 payment:該對象即是在小程序端調(diào)用 wx.requestPayment 所需的信息

回調(diào)云函數(shù)返回協(xié)議

支付結(jié)果回調(diào)的云函數(shù)必須返回如下一個(gè)對象,否則會(huì)視為回調(diào)不成功,云函數(shù)會(huì)收到重復(fù)的支付回調(diào):

字段名變量名必填類型描述
錯(cuò)誤碼errcodeNumber0
錯(cuò)誤信息errmsgString

參數(shù)說明

字段名變量名必填類型示例值描述
結(jié)果通知回調(diào)云函數(shù)名functionNameStringpaycallback接收微信支付異步通知回調(diào)的云函數(shù)名
結(jié)果通知回調(diào)云函數(shù)環(huán)境envIdStringtest-123接收微信支付異步通知回調(diào)的云函數(shù)所在的環(huán)境 ID
子商戶號(hào)subMchIdString(32)1900000109微信支付分配的子商戶號(hào)
設(shè)備號(hào)deviceInfoString(32)013467007045764終端設(shè)備號(hào)(門店號(hào)或收銀設(shè)備ID),注意:PC網(wǎng)頁或公眾號(hào)內(nèi)支付請傳"WEB"
隨機(jī)字符串nonceStrString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS隨機(jī)字符串,不長于32位。推薦隨機(jī)數(shù)生成算法
商品描述bodyString(128)騰訊充值中心-QQ會(huì)員充值商品簡單描述,該字段須嚴(yán)格按照規(guī)范傳遞,具體請見參數(shù)規(guī)定
商品詳情detailString(6000)商品詳細(xì)描述,對于使用單品優(yōu)惠的商戶,該字段必須按照規(guī)范上傳,詳見“單品優(yōu)惠參數(shù)說明”
附加數(shù)據(jù)attachString(127)說明附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù)
商戶訂單號(hào)outTradeNoString(32)1217752501201407033233368018商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-
貨幣類型feeTypeString(16)CNY符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型
總金額totalFeeInt888訂單總金額,只能為整數(shù),詳見支付金額
終端IPspbillCreateIpString(64)123.12.12.123支持IPV4和IPV6兩種格式的IP地址。調(diào)用微信支付API的機(jī)器IP
交易起始時(shí)間timeStartString(14)20091225091010訂單生成時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見時(shí)間規(guī)則
交易結(jié)束時(shí)間timeExpireString(14)20091227091010訂單失效時(shí)間,格式為yyyyMMddHHmmss,如2009年12月27日9點(diǎn)10分10秒表示為20091227091010。訂單失效時(shí)間是針對訂單號(hào)而言的,由于在請求支付的時(shí)候有一個(gè)必傳參數(shù)prepay_id只有兩小時(shí)的有效期,所以在重入時(shí)間超過2小時(shí)的時(shí)候需要重新請求下單接口獲取新的prepay_id。其他詳見時(shí)間規(guī)則。
建議:最短失效時(shí)間間隔大于1分鐘
訂單優(yōu)惠標(biāo)記goodsTagString(32)WXG訂單優(yōu)惠標(biāo)記,代金券或立減優(yōu)惠功能的參數(shù),說明詳見代金券或立減優(yōu)惠
交易類型tradeTypeString(16)JSAPI小程序取值如下:JSAPI,詳細(xì)說明見參數(shù)規(guī)定
指定支付方式limitPayString(32)no_creditno_credit--指定不能使用信用卡支付
用戶標(biāo)識(shí)openidString(128)oUpF8uMuAJO_M2pxb1Q9zNjWeS6otrade_type=JSAPI,此參數(shù)必傳,用戶在商戶appid下的唯一標(biāo)識(shí)。openid如何獲取,可參考【獲取openid】。
用戶子標(biāo)識(shí)subOpenidString(128)oUpF8uMuAJO_M2pxb1Q9zNjWeS6otrade_type=JSAPI,此參數(shù)必傳,用戶在子商戶appid下的唯一標(biāo)識(shí)。openid和sub_openid可以選傳其中之一,如果選擇傳sub_openid,則必須傳sub_appid。下單前需要調(diào)用【網(wǎng)頁授權(quán)獲取用戶信息】接口獲取到用戶的Openid。
電子發(fā)票入口開放標(biāo)識(shí)receiptString(8)YY,傳入Y時(shí),支付成功消息和支付詳情頁將出現(xiàn)開票入口。需要在微信支付商戶平臺(tái)或微信公眾平臺(tái)開通電子發(fā)票功能,傳此字段才可生效
場景信息sceneInfoString(256)Y該字段常用于線下活動(dòng)時(shí)的場景信息上報(bào),支持上報(bào)實(shí)際門店信息,商戶也可以按需求自己上報(bào)相關(guān)信息。該字段為JSON對象數(shù)據(jù),對象格式為{"store_info":{"id": "門店ID","name": "名稱","area_code": "編碼","address": "地址" }}

sceneInfo.storeInfo 對象說明*

字段名變量名必填類型示例值描述
門店ididString(32)SZTX001門店編號(hào),由商戶自定義
門店名稱nameString(64)騰訊大廈騰大餐廳門店名稱 ,由商戶自定義
門店行政區(qū)劃碼area_codeString(6)440305門店所在地行政區(qū)劃碼,詳細(xì)見《最新縣及縣以上行政區(qū)劃代碼》
門店詳細(xì)地址addressString(128)科技園中一路騰訊大廈門店詳細(xì)地址 ,由商戶自定義

返回值說明

字段名變量名必填類型示例值描述
返回狀態(tài)碼returnCodeString(16)SUCCESSSUCCESS/FAIL 此字段是通信標(biāo)識(shí),非交易標(biāo)識(shí),交易是否成功需要查看result_code來判斷
返回信息returnMsgString(128)簽名失敗返回信息,如非空,為錯(cuò)誤原因。如 簽名失敗、參數(shù)格式校驗(yàn)錯(cuò)誤

以下字段在returnCode為SUCCESS的時(shí)候有返回

字段名變量名必填類型示例值描述
小程序中發(fā)起支付所需信息paymentObject小程序端調(diào)用 wx.requestPayment 所需信息
服務(wù)商的APPIDappidString(32)wxd678efh567hg6787服務(wù)商商戶的APPID
商戶號(hào)mch_idString(32)1900000109調(diào)用接口提交的商戶號(hào)
小程序的APPIDsub_appidString(32)wx8888888888888888微信分配的小程序ID
子商戶號(hào)sub_mch_idString(32)1900000109微信支付分配的子商戶號(hào)
設(shè)備號(hào)device_infoString(32)013467007045764調(diào)用接口提交的終端設(shè)備號(hào),
隨機(jī)字符串nonce_strString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS微信返回的隨機(jī)字符串
簽名signString(64)C380BEC2BFD727A4B6845133519F3AD6微信返回的簽名,詳見簽名算法
業(yè)務(wù)結(jié)果result_codeString(16)SUCCESSSUCCESS/FAIL
錯(cuò)誤代碼err_codeString(32)SYSTEMERROR詳細(xì)參見第6節(jié)錯(cuò)誤列表
錯(cuò)誤代碼描述err_code_desString(128)系統(tǒng)錯(cuò)誤錯(cuò)誤返回的信息描述

以下字段在returnCode 和result_code都為SUCCESS的時(shí)候有返回

字段名變量名必填類型示例值描述
交易類型trade_typeString(16)JSAPI調(diào)用接口提交的交易類型,取值如下:JSAPI,詳細(xì)說明見參數(shù)規(guī)定
預(yù)支付交易會(huì)話標(biāo)識(shí)prepay_idString(64)wx201410272009395522657a690389285100微信生成的預(yù)支付回話標(biāo)識(shí),用于后續(xù)接口調(diào)用中使用,該值有效期為2小時(shí)
二維碼鏈接code_urlString(64)weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00trade_type=NATIVE時(shí)有返回,此url用于生成支付二維碼,然后提供給用戶進(jìn)行掃碼支付。注意:code_url的值并非固定,使用時(shí)按照URL格式轉(zhuǎn)成二維碼即可

錯(cuò)誤碼

名稱描述原因解決方案
INVALID_REQUEST參數(shù)錯(cuò)誤參數(shù)格式有誤或者未按規(guī)則上傳訂單重入時(shí),要求參數(shù)值與原請求一致,請確認(rèn)參數(shù)問題
NOAUTH商戶無此接口權(quán)限商戶未開通此接口權(quán)限請商戶前往申請此接口權(quán)限
NOTENOUGH余額不足用戶帳號(hào)余額不足用戶帳號(hào)余額不足,請用戶充值或更換支付卡后再支付
ORDERPAID商戶訂單已支付商戶訂單已支付,無需重復(fù)操作商戶訂單已支付,無需更多操作
ORDERCLOSED訂單已關(guān)閉當(dāng)前訂單已關(guān)閉,無法支付當(dāng)前訂單已關(guān)閉,請重新下單
SYSTEMERROR系統(tǒng)錯(cuò)誤系統(tǒng)超時(shí)系統(tǒng)異常,請用相同參數(shù)重新調(diào)用
APPID_NOT_EXISTAPPID不存在參數(shù)中缺少APPID請檢查APPID是否正確
MCHID_NOT_EXISTMCHID不存在參數(shù)中缺少M(fèi)CHID請檢查MCHID是否正確
APPID_MCHID_NOT_MATCHappid和mch_id不匹配appid和mch_id不匹配請確認(rèn)appid和mch_id是否匹配
LACK_PARAMS缺少參數(shù)缺少必要的請求參數(shù)請檢查參數(shù)是否齊全
OUT_TRADE_NO_USED商戶訂單號(hào)重復(fù)同一筆交易不能多次提交請核實(shí)商戶訂單號(hào)是否重復(fù)提交
SIGNERROR簽名錯(cuò)誤參數(shù)簽名結(jié)果不正確請檢查簽名參數(shù)和方法是否都符合簽名算法要求
XML_FORMAT_ERRORXML格式錯(cuò)誤XML格式錯(cuò)誤請檢查XML參數(shù)格式是否正確
REQUIRE_POST_METHOD請使用post方法未使用post傳遞參數(shù)請檢查請求參數(shù)是否通過post方法提交
POST_DATA_EMPTYpost數(shù)據(jù)為空post數(shù)據(jù)不能為空請檢查post數(shù)據(jù)是否為空
NOT_UTF8編碼格式錯(cuò)誤未使用指定編碼格式請使用UTF-8編碼格式

示例代碼

// 云函數(shù)代碼
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: '函數(shù)名',
  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,
})


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)