微信小程序云開發(fā)SDK文檔 微信支付·查詢訂單

2020-07-27 14:27 更新

CloudPay.queryOrder()

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

查詢訂單

說明

該接口提供所有微信支付訂單的查詢,商戶可以通過該接口主動(dòng)查詢訂單狀態(tài),完成下一步的業(yè)務(wù)邏輯。

需要調(diào)用查詢接口的情況:

◆ 當(dāng)商戶后臺(tái)、網(wǎng)絡(luò)、服務(wù)器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知; ◆ 調(diào)用支付接口后,返回系統(tǒng)錯(cuò)誤或未知交易狀態(tài)情況; ◆ 調(diào)用被掃支付API,返回USERPAYING的狀態(tài); ◆ 調(diào)用關(guān)單或撤銷接口API之前,需確認(rèn)支付狀態(tài);

參數(shù)說明

字段名變量名必填類型示例值描述
子商戶號(hào)sub_mch_idString(32)1900000109微信支付分配的子商戶號(hào)
微信訂單號(hào)transaction_id二選一String(32)1009660380201506130728806387微信的訂單號(hào),優(yōu)先使用
商戶訂單號(hào)out_trade_noString(32)1217752501201407033233368018商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-*@ ,且在同一個(gè)商戶號(hào)下唯一。
隨機(jī)字符串nonce_strString(32)C380BEC2BFD727A4B6845133519F3AD6隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法

返回值說明

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

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

字段名變量名必填類型示例值描述
服務(wù)商的APPIDappidString(32)wxd678efh567hg6787服務(wù)商商戶的APPID
商戶號(hào)mch_idString(32)1230000109微信支付分配的商戶號(hào)
小程序的APPIDsub_appidString(32)wx8888888888888888微信分配的小程序ID
子商戶號(hào)sub_mch_idString(32)1900000109微信支付分配的子商戶號(hào)
隨機(jī)字符串nonce_strString(32)5K8264ILTKCH16CQ2502SI8ZNMTM67VS隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法
簽名signString(32)C380BEC2BFD727A4B6845133519F3AD6簽名,詳見簽名生成算法
業(yè)務(wù)結(jié)果result_codeString(16)SUCCESSSUCCESS/FAIL
錯(cuò)誤代碼err_codeString(32)SYSTEMERROR錯(cuò)誤碼
錯(cuò)誤代碼描述err_code_desString(128)系統(tǒng)錯(cuò)誤結(jié)果信息描述

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

字段名變量名必填類型示例值描述
設(shè)備號(hào)device_infoString(32)013467007045764微信支付分配的終端設(shè)備號(hào),
用戶標(biāo)識(shí)openidString(128)oUpF8uMuAJO_M2pxb1Q9zNjWeS6o用戶在商戶appid下的唯一標(biāo)識(shí)
是否關(guān)注公眾賬號(hào)is_subscribeString(1)Y用戶是否關(guān)注公眾賬號(hào),Y-關(guān)注,N-未關(guān)注
用戶子標(biāo)識(shí)sub_openidString(128)wxd930ea5d5a258f4f用戶在子商戶appid下的唯一標(biāo)識(shí)
是否關(guān)注子公眾賬號(hào)sub_is_subscribeString(1)Y用戶是否關(guān)注子公眾賬號(hào),Y-關(guān)注,N-未關(guān)注
交易類型trade_typeString(16)JSAPI調(diào)用接口提交的交易類型,取值如下:JSAPI,NATIVE,APP,MICROPAY,詳細(xì)說明見參數(shù)規(guī)定
交易狀態(tài)trade_stateString(32)SUCCESSSUCCESS—支付成功
REFUND—轉(zhuǎn)入退款
NOTPAY—未支付
CLOSED—已關(guān)閉
REVOKED—已撤銷(刷卡支付)
USERPAYING--用戶支付中
PAYERROR--支付失敗(其他原因,如銀行返回失敗)
付款銀行bank_typeString(16)CMC銀行類型,采用字符串類型的銀行標(biāo)識(shí)
訂單金額total_feeInt100訂單總金額,單位為分
標(biāo)價(jià)幣種fee_typeString(8)CNY貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型
應(yīng)結(jié)訂單金額settlement_total_feeInt100當(dāng)訂單使用了免充值型優(yōu)惠券后返回該參數(shù),應(yīng)結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。
現(xiàn)金支付金額cash_feeInt100現(xiàn)金支付金額訂單現(xiàn)金支付金額,詳見支付金額
現(xiàn)金支付貨幣類型cash_fee_typeString(16)CNY貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型
代金券金額coupon_feeInt100“代金券或立減優(yōu)惠”金額<=訂單總金額,訂單總金額-“代金券或立減優(yōu)惠”金額=現(xiàn)金支付金額,詳見支付金額
代金券使用數(shù)量coupon_countInt1代金券或立減優(yōu)惠使用數(shù)量
代金券IDcoupon_id_$nString(20)10000代金券或立減優(yōu)惠ID, $n為下標(biāo),從0開始編號(hào)
代金券類型coupon_type_$nStringCASHCASH--充值代金券
NO_CASH---非充值優(yōu)惠券
開通免充值券功能,并且訂單使用了優(yōu)惠券后有返回(取值:CASH、NO_CASH)。$n為下標(biāo),從0開始編號(hào),舉例:coupon_type_$0
單個(gè)代金券金額coupon_fee_$nInt100單個(gè)代金券或立減優(yōu)惠支付金額, $n為下標(biāo),從0開始編號(hào)
微信支付訂單號(hào)transaction_idString(32)1217752501201407033233368018微信支付訂單號(hào)
商戶訂單號(hào)out_trade_noString(32)1217752501201407033233368018商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-
商家數(shù)據(jù)包attachString(128)123456商家數(shù)據(jù)包,原樣返回
支付完成時(shí)間time_endString(14)20141030133525訂單支付時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見時(shí)間規(guī)則
交易狀態(tài)描述trade_state_descString(256)支付失敗,請(qǐng)重新下單支付對(duì)當(dāng)前查詢訂單狀態(tài)的描述和下一步操作的指引

錯(cuò)誤碼

名稱描述原因解決方案
ORDERNOTEXIST此交易訂單號(hào)不存在查詢系統(tǒng)中不存在此交易訂單號(hào)該API只能查提交支付交易返回成功的訂單,請(qǐng)商戶檢查需要查詢的訂單號(hào)是否正確
SYSTEMERROR系統(tǒng)錯(cuò)誤后臺(tái)系統(tǒng)返回錯(cuò)誤系統(tǒng)異常,請(qǐng)?jiān)僬{(diào)用發(fā)起查詢


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

掃描二維碼

下載編程獅App

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

編程獅公眾號(hào)