最新更新時間:2020..10 版本說明
商戶系統(tǒng)先調(diào)用該接口在微信支付服務(wù)后臺生成預(yù)支付交易單,返回正確的預(yù)支付交易會話標(biāo)識后再按Native、JSAPI、APP等不同場景生成交易串調(diào)起支付。。
適用對象: 直連商戶 服務(wù)商
請求URL: https://api.mch.weixin.qq.com/pay/unifiedorder
冗災(zāi)備用URL: https://api2.mch.weixin.qq.com/pay/unifiedorder(備用域名)見跨城冗災(zāi)方案
請求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 否
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值:wx8888888888888888 |
商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務(wù)商模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意:僅適用于服務(wù)商模式 示例值:1900000109 |
設(shè)備號 | device_info | string[1,32] | 否 | 終端設(shè)備號(商戶自定義,如門店號或收銀設(shè)備ID), 注意:PC網(wǎng)頁或JSAPI支付請傳"WEB" 示例值:013467007045764 |
隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
簽名類型 | sign_type | string[1,32] | 否 | 簽名類型,目前支持HMAC-SHA256和MD5,默認(rèn)為MD5 示例值:HMAC-SHA256 |
商品描述 | body | string[1,127] | 是 | 商品描述交易字段格式根據(jù)不同的應(yīng)用場景建議按照以下格式上傳: (1)PC網(wǎng)站——傳入瀏覽器打開的網(wǎng)站主頁title名-實際商品名稱,例如:騰訊充值中心-QQ會員充值; (2) 公眾號——傳入公眾號名稱-實際商品名稱,例如:騰訊形象店- image-QQ公仔; (3) H5——應(yīng)用在瀏覽器網(wǎng)頁上的場景,傳入瀏覽器打開的移動網(wǎng)頁的主頁title名-實際商品名稱,例如:騰訊充值中心-QQ會員充值; (4) 線下門店——門店品牌名-城市分店名-實際商品名稱,例如: image形象店-深圳騰大- QQ公仔) (5) APP——需傳入應(yīng)用市場上的APP名字-實際商品名稱,天天愛消除-游戲充值。 示例值:騰訊充值中心-QQ會員充值 |
商品詳情 | detail | string[1,6000] | 否 | 商品詳細(xì)描述,對于使用單品優(yōu)惠的商戶,改字段必須按照規(guī)范上傳,詳見“單品優(yōu)惠參數(shù)說明” 示例值:440305 |
附加數(shù)據(jù) | attach | string[1,127] | 否 | 附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù) 示例值:說明 |
商戶訂單號 | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號,要求32個字符內(nèi),只能是數(shù)字、大小寫字母_-|*且在同一個商戶號下唯一。詳見商戶訂單號 示例值:1217752501201407033233368018 |
貨幣類型 | fee_type | string[1,16] | 否 | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見貨幣類型 示例值:CNY |
總金額 | total_fee | int | 是 | 訂單總金額,只能為整數(shù),詳見交易金額 示例值:888 |
終端IP | spbill_create_ip | string[1,64] | 是 | 支持IPV4和IPV6兩種格式的IP地址。調(diào)用微信支付API的機器IP 示例值:123.12.12.123 |
交易起始時間 | time_start | string[1,14] | 否 | 訂單生成時間,格式為yyyyMMddHHmmss,如2009年12月25日9點10分10秒表示為20091225091010。其他詳見時間規(guī)則 示例值:20091225091010 |
交易結(jié)束時間 | time_expire | string[1,14] | 否 | 訂單失效時間,格式為yyyyMMddHHmmss,如2009年12月27日9點10分10秒表示為20091227091010。訂單失效時間是針對訂單號而言的,由于在請求支付的時候有一個必傳參數(shù)prepay_id只有兩小時的有效期,所以在重入時間超過2小時的時候需要重新請求下單接口獲取新的prepay_id。其他詳見時間規(guī)則 示例值:20091227091010 |
訂單優(yōu)惠標(biāo)記 | goods_tag | string[1,32] | 否 | 訂單優(yōu)惠標(biāo)記,代金券或立減優(yōu)惠功能的參數(shù),說明詳見代金券或立減優(yōu)惠 示例值:WXG |
通知地址 | notify_url | string[1,256] | 是 | 接收微信支付異步通知回調(diào)地址,通知url必須為直接可訪問的url,不能攜帶參數(shù)。 示例值:http://www.weixin.qq.com/wxpay/pay.php |
交易類型 | trade_type | string[1,16] | 是 | JSAPI--JSAPI支付(或小程序支付) NATIVE:Native支付 APP:APP支付 MWEB:H5支付 說明詳見交易類型 示例值:JSAPI |
商品ID | product_id | string[1,32] | 否 | trade_type=NATIVE時,此參數(shù)必傳。此id為二維碼中包含的商品ID,商戶自行定義。 示例值:12235413214070356458058 |
指定支付方式 | limit_pay | string[1,32] | 否 | no_credit--指定不能使用信用卡支付 示例值:no_credit |
用戶標(biāo)識 | openid | string[1,128] | 否 | trade_type=JSAPI,此參數(shù)必傳,用戶在主商戶appid下的唯一標(biāo)識。openid和sub_openid可以選傳其中之一,如果選擇傳sub_openid,則必須傳sub_appid。下單前需要調(diào)用【網(wǎng)頁授權(quán)獲取用戶信息】接口獲取到用戶的Openid。 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
用戶子標(biāo)識 | sub_openid | string[1,128] | 否 | trade_type=JSAPI,此參數(shù)必傳,用戶在子商戶appid下的唯一標(biāo)識。openid和sub_openid可以選傳其中之一,如果選擇傳sub_openid,則必須傳sub_appid。下單前需要調(diào)用【網(wǎng)頁授權(quán)獲取用戶信息】接口獲取到用戶的Openid。 注意:僅適用于服務(wù)商模式 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
電子發(fā)票入口開放標(biāo)識 | receipt | string[1,8] | 否 | 傳入Y時,支付成功消息和支付詳情頁將出現(xiàn)開票入口。需要在微信支付商戶平臺或微信公眾平臺開通電子發(fā)票功能,傳此字段才可生效 示例值:Y |
+ 場景信息 | scene_info | string[1,256] | 否 | body 該字段用于上報場景信息,目前支持上報實際門店信息。該字段為JSON對象數(shù)據(jù),對象格式為{"store_info":{"id": "門店ID","name": "名稱","area_code": "編碼","address": "地址" }} ,字段詳細(xì)說明請點擊行前的+展開 示例值:wx8888888888888888 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<attach>支付測試</attach>
<body>JSAPI支付測試</body>
<mch_id>10000100</mch_id>
<detail><![CDATA[{ "goods_detail":[ { "goods_id":"iphone6s_16G", "wxpay_goods_id":"1001", "goods_name":"iPhone6s 16G", "quantity":1, "price":528800, "goods_category":"123456", "body":"蘋果手機" }, { "goods_id":"iphone6s_32G", "wxpay_goods_id":"1002", "goods_name":"iPhone6s 32G", "quantity":1, "price":608800, "goods_category":"123789", "body":"蘋果手機" } ] }]]></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ù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識,非交易標(biāo)識,交易是否成功需要查看result_code來判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 示例值:簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時候,包含以下字段
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商商戶的APPID 示例值:wx8888888888888888 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 是 | 調(diào)用接口提交的子商戶公眾賬號ID 注意:僅適用于服務(wù)商模式 示例值:wx8888888888888888 |
商戶號 | mch_id | string[1,32] | 是 | 調(diào)用接口提交的商戶號 示例值:1900000109 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 調(diào)用接口提交的子商戶號 注意:僅適用于服務(wù)商模式 示例值:2100000109 |
設(shè)備號 | device_info | string[1,32] | 否 | 調(diào)用接口提交的終端設(shè)備號, 示例值:013467007045764 |
隨機字符串 | nonce_str | string[1,32] | 是 | 微信返回的隨機字符串 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 微信返回的簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值:SUCCESS |
錯誤代碼 | err_code | string[1,32] | 否 | 詳細(xì)參見錯誤列表 示例值:SYSTEMERROR |
錯誤代碼描述 | err_code_des | string[1,128] | 否 | 結(jié)果信息描述 示例值:系統(tǒng)錯誤 |
返回狀態(tài)碼(return_code)和業(yè)務(wù)結(jié)果(result_code)都為SUCCESS的時候,包含以下字段
參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
---|---|---|---|---|
交易類型 | trade_type | string[1,16] | 是 | 支付類型為MICROPAY(即掃碼支付) 示例值:MICROPAY |
預(yù)支付交易會話標(biāo)識 | prepay_id | string[1,64] | 是 | 微信生成的預(yù)支付會話標(biāo)識,用于后續(xù)接口調(diào)用中使用,該值有效期為2小時 示例值:wx201410272009395522657a690389285100 |
二維碼鏈接 | code_url | string[1,64] | 是 | trade_type=NATIVE時有返回,此url用于生成支付二維碼,然后提供給用戶進行掃碼支付。 注意:code_url的值并非固定,使用時按照URL格式轉(zhuǎn)成二維碼即可 示例值:weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 |
<xml> <return_code><![CDATA[SUCCESS]]></return_code> <return_msg><![CDATA[OK]]></return_msg> <appid><![CDATA[wx2421b1c4370ec43b]]></appid> <mch_id><![CDATA[10000100]]></mch_id> <device_info><![CDATA[1000]]></device_info> <nonce_str><![CDATA[GOp3TRyMXzbMlkun]]></nonce_str> <sign><![CDATA[D6C76CB785F07992CDE05494BB7DF7FD]]></sign> <result_code><![CDATA[SUCCESS]]></result_code> <openid><![CDATA[oUpF8uN95-Ptaags6E_roPHg7AG0]]></openid> <is_subscribe><![CDATA[Y]]></is_subscribe> <trade_type><![CDATA[MICROPAY]]></trade_type> <bank_type><![CDATA[CCB_DEBIT]]></bank_type> <total_fee>1</total_fee> <coupon_fee>0</coupon_fee> <fee_type><![CDATA[CNY]]></fee_type> <out_trade_no><![CDATA[1415757673]]></out_trade_no> <attach><![CDATA[訂單額外描述]]></attach> <time_end><![CDATA[20141111170043]]></time_end> </xml>
錯誤碼 | 描述 | 解決方案 |
---|---|---|
PARAM_ERROR | 參數(shù)錯誤 | 請檢查請求參數(shù)再試 |
PARAM_ERROR | 參數(shù)錯誤 | 請檢查請求參數(shù)再試 |