統(tǒng)一下單
應(yīng)用場景
除付款碼支付場景以外,商戶系統(tǒng)先調(diào)用該接口在微信支付服務(wù)后臺生成預(yù)支付交易單,返回正確的預(yù)支付交易會話標(biāo)識后再按Native、JSAPI、APP等不同場景生成交易串調(diào)起支付。
接口地址
https://apihk.mch.weixin.qq.com/pay/unifiedorder (建議接入點:東南亞)
https://apius.mch.weixin.qq.com/pay/unifiedorder (建議接入點:其它)
https://api.mch.weixin.qq.com/pay/unifiedorder (建議接入點:中國國內(nèi))
注:商戶可根據(jù)實際請求情況選擇最優(yōu)域名進行訪問,建議在接入時做好兼容,當(dāng)訪問其中一個域名出現(xiàn)異常時,可自動切換為其他域名。
是否需要證書
不需要
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公眾賬號ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信分配的公眾賬號ID(企業(yè)號corpid即為此appId) |
商戶號 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商戶號 |
設(shè)備號 | device_info | 否 | String(32) | 013467007045764 | 終端設(shè)備號(門店號或收銀設(shè)備ID),注意:PC網(wǎng)頁或公眾號內(nèi)支付請傳"WEB" |
隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 |
簽名 | sign | 是 | String(64) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見簽名生成算法 |
簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型,目前支持HMAC-SHA256和MD5,默認(rèn)為MD5 |
商品描述 | body | 是 | String(128) | Ipad mini 16G 白色 | 商品或支付單簡要描述 |
版本號 | version | 否 | String(32) | 1.0 | 固定值 1.0 |
商品詳情 | detail | 否 | String(6000) | { "goods_detail":[ { "goods_name":"iPhone6s 16G", "quantity":1, }, { "goods_name":"iPhone6s 32G", "quantity":1, } ] } |
商品詳細(xì)列表,使用Json格式,傳輸簽名前請務(wù)必使用CDATA標(biāo)簽將JSON文本串保護起來。 goods_detail |
附加數(shù)據(jù) | attach | 否 | String(127) | 深圳分店 | 附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù) |
商戶訂單號 | out_trade_no | 是 | String(32) | 20150806125346 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*且在同一個商戶號下唯一。 其他說明見商戶訂單號 |
標(biāo)價幣種 | fee_type | 是 | String(16) | GBP | 符合ISO4217標(biāo)準(zhǔn)的三位字母代碼詳見標(biāo)價幣種 |
標(biāo)價金額 | total_fee | 是 | int | 888 | 標(biāo)價金額,單位為該幣種最小計算單位,只能為整數(shù),詳見標(biāo)價金額 |
終端IP | spbill_create_ip | 是 | String(64) | 123.12.12.123 | 支持IPV4和IPV6兩種格式的IP地址。調(diào)用微信支付API的機器IP |
交易起始時間 | time_start | 否 | String(14) | 20091225091010 | 訂單生成時間,格式為yyyyMMddHHmmss,如2009年12月25日9點10分10秒表示為20091225091010。其他詳見時間規(guī)則 |
交易結(jié)束時間 | time_expire | 否 | String(14) | 20091227091010 | 訂單失效時間,格式為yyyyMMddHHmmss,如2009年12月27日9點10分10秒表示為20091227091010。其他詳見時間規(guī)則 |
通知地址 | notify_url | 是 | String(256) | http://www.weixin.qq.com/wxpay/pay.php | 接收微信支付異步通知回調(diào)地址 |
交易類型 | trade_type | 是 | String(16) | JSAPI | 取值如下:JSAPI,NATIVE,APP,詳細(xì)說明見參數(shù)規(guī)定 |
商品ID | product_id | 否 | String(32) | 12235413214070356458058 | trade_type=NATIVE時,此參數(shù)必傳。此id為二維碼中包含的商品ID,商戶自行定義。 |
指定支付方式 | limit_pay | 否 | String(32) | no_credit | no_credit--指定不能使用信用卡支付 |
用戶標(biāo)識 | openid | 否 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | trade_type=JSAPI,此參數(shù)必傳,用戶在商戶appid下的唯一標(biāo)識。openid如何獲取,可參考【獲取openid】。企業(yè)號請使用【企業(yè)號OAuth2.0接口】獲取企業(yè)號內(nèi)成員userid,再調(diào)用【企業(yè)號userid轉(zhuǎn)openid接口】進行轉(zhuǎn)換 |
開發(fā)票入口開放標(biāo)識 | receipt | 否 | String(8) | Y | Y,傳入Y時,支付成功消息和支付詳情頁將出現(xiàn)開票入口。需要在微信支付商戶平臺或微信公眾平臺開通電子發(fā)票功能,傳此字段才可生效 |
舉例如下:
<xml>
<appid>wx2421b1c4370ec43b</appid>
<attach>支付測試</attach>
<body>JSAPI支付測試</body>
<mch_id>10000100</mch_id>
<detail><![CDATA[{"goods_detail":[{"goods_name":"iPhone6s 16G","quantity":1,},{ "goods_name":"iPhone6s 32G","quantity":1, }]}]]></detail>
<nonce_str>1add1a30ac87aa2db72f57a2375d8fec</nonce_str>
<notify_url>http://wxpay.wxutil.com/pub_v2/pay/notify.v2.php</notify_url>
<openid>oUpF8uMuAJO_M2pxb1Q9zNjWeS6o</openid>
<out_trade_no>1415659990</out_trade_no>
<spbill_create_ip>14.23.150.211</spbill_create_ip>
<total_fee>1</total_fee>
<trade_type>JSAPI</trade_type>
<sign>0CB01533B8C1EF103065174F50BCA001</sign>
</xml>
注:參數(shù)值用XML轉(zhuǎn)義即可,CDATA標(biāo)簽用于說明數(shù)據(jù)不被XML解析器解析。
返回結(jié)果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信標(biāo)識,非交易標(biāo)識,交易是否成功需要查看result_code來判斷 |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 |
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公眾賬號ID | appid | 是 | String(32) | wx8888888888888888 | 調(diào)用接口提交的公眾賬號ID |
商戶號 | mch_id | 是 | String(32) | 1900000109 | 調(diào)用接口提交的商戶號 |
設(shè)備號 | device_info | 否 | String(32) | 013467007045764 | 調(diào)用接口提交的終端設(shè)備號, |
隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的隨機字符串 |
簽名 | sign | 是 | String(64) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的簽名,詳見簽名算法 |
業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
錯誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 詳細(xì)參見第6節(jié)錯誤列表 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)錯誤 | 錯誤返回的信息描述 |
以下字段在return_code 和result_code都為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
交易類型 | trade_type | 是 | String(16) | JSAPI | 調(diào)用接口提交的交易類型,取值如下:JSAPI,NATIVE,APP,詳細(xì)說明見參數(shù)規(guī)定 |
預(yù)支付交易會話標(biāo)識 | prepay_id | 是 | String(64) | wx201410272009395522657a690389285100 | 微信生成的預(yù)支付會話標(biāo)識,用于后續(xù)接口調(diào)用中使用,該值有效期為2小時 |
二維碼鏈接 | code_url | 否 | String(64) | weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 | trade_type=NATIVE時有返回,此url用于生成支付二維碼,然后提供給用戶進行掃碼支付。 注意:code_url的值并非固定,使用時按照URL格式轉(zhuǎn)成二維碼即可 |
舉例如下:
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[IITRi8Iabbblz1Jc]]></nonce_str>
<sign><![CDATA[7921E432F65EB8ED0CE9755F0E86D72F]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<prepay_id><![CDATA[wx201411101639507cbf6ffd8b0779950874]]></prepay_id>
<trade_type><![CDATA[JSAPI]]></trade_type>
</xml>
錯誤碼
名稱 | 描述 | 原因 | 解決方案 |
---|---|---|---|
INVALID_REQUEST | 參數(shù)錯誤 | 參數(shù)格式有誤或者未按規(guī)則上傳 | 訂單重入時,要求參數(shù)值與原請求一致,請確認(rèn)參數(shù)問題 |
NOAUTH | 商戶無此接口權(quán)限 | 商戶未開通此接口權(quán)限 | 請商戶前往申請此接口權(quán)限 |
ORDERPAID | 商戶訂單已支付 | 商戶訂單已支付,無需重復(fù)操作 | 商戶訂單已支付,無需更多操作 |
ORDERCLOSED | 訂單已關(guān)閉 | 當(dāng)前訂單已關(guān)閉,無法支付 | 當(dāng)前訂單已關(guān)閉,請重新下單 |
SYSTEMERROR | 系統(tǒng)錯誤 | 系統(tǒng)超時 | 系統(tǒng)異常,請用相同參數(shù)重新調(diào)用 |
APPID_NOT_EXIST | APPID不存在 | 參數(shù)中缺少APPID | 請檢查APPID是否正確 |
MCHID_NOT_EXIST | MCHID不存在 | 參數(shù)中缺少MCHID | 請檢查MCHID是否正確 |
APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 請確認(rèn)appid和mch_id是否匹配 |
LACK_PARAMS | 缺少參數(shù) | 缺少必要的請求參數(shù) | 請檢查參數(shù)是否齊全 |
OUT_TRADE_NO_USED | 商戶訂單號重復(fù) | 同一筆交易不能多次提交 | 請核實商戶訂單號是否重復(fù)提交 |
SIGNERROR | 簽名錯誤 | 參數(shù)簽名結(jié)果不正確 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
XML_FORMAT_ERROR | XML格式錯誤 | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |
REQUIRE_POST_METHOD | 請使用post方法 | 未使用post傳遞參數(shù) | 請檢查請求參數(shù)是否通過post方法提交 |
POST_DATA_EMPTY | post數(shù)據(jù)為空 | post數(shù)據(jù)不能為空 | 請檢查post數(shù)據(jù)是否為空 |
NOT_UTF8 | 編碼格式錯誤 | 未使用指定編碼格式 | 請使用UTF-8編碼格式 |