最新更新時(shí)間:2020.10.10 版本說(shuō)明
收銀員使用掃碼設(shè)備讀取微信用戶付款碼以后,二維碼或條碼信息會(huì)傳送至商戶收銀臺(tái),由商戶收銀臺(tái)或者商戶后臺(tái)調(diào)用該接口發(fā)起支付。
1、提交支付請(qǐng)求后微信會(huì)同步返回支付結(jié)果。當(dāng)返回結(jié)果為“系統(tǒng)錯(cuò)誤”時(shí),商戶系統(tǒng)等待5秒后調(diào)用【查詢訂單API】,查詢支付實(shí)際交易結(jié)果;當(dāng)返回結(jié)果為“USERPAYING”時(shí),商戶系統(tǒng)可設(shè)置間隔時(shí)間(建議10秒)重新查詢支付結(jié)果,直到支付成功或超時(shí)(建議30秒);
2、在調(diào)用查詢接口返回后,如果交易狀況不明晰,請(qǐng)調(diào)用【撤銷訂單API】,此時(shí)如果交易失敗則關(guān)閉訂單,該單不能再支付成功;如果交易成功,則將扣款退回到用戶賬戶。當(dāng)撤銷無(wú)返回或錯(cuò)誤時(shí),請(qǐng)?jiān)俅握{(diào)用。注意:請(qǐng)勿扣款后立即調(diào)用【撤銷訂單API】,建議至少15秒后再調(diào)用。撤銷訂單API需要雙向證書。
適用對(duì)象: 直連商戶 服務(wù)商
請(qǐng)求URL: https://api.mch.weixin.qq.com/pay/micropay
冗災(zāi)備用URL: https://api2.mch.weixin.qq.com/pay/micropay(備用域名)見(jiàn)跨城冗災(zāi)方案
請(qǐng)求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 否
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值:wx8888888888888888 |
商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值:1900000109 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務(wù)商模式 示例值:wx8888888888888888 |
子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意:僅適用于服務(wù)商模式 示例值:1900000109 |
設(shè)備號(hào) | device_info | string[1,32] | 否 | 終端設(shè)備號(hào)(商戶自定義,如門店號(hào)或收銀設(shè)備ID), 注意:PC網(wǎng)頁(yè)或JSAPI支付請(qǐng)傳"WEB" 示例值:013467007045764 |
隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串,不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見(jiàn)簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
商品描述 | body | string[1,127] | 是 | 商品描述交易字段格式根據(jù)不同的應(yīng)用場(chǎng)景建議按照以下格式上傳: (1)PC網(wǎng)站——傳入瀏覽器打開(kāi)的網(wǎng)站主頁(yè)title名-實(shí)際商品名稱,例如:騰訊充值中心-QQ會(huì)員充值; (2) 公眾號(hào)——傳入公眾號(hào)名稱-實(shí)際商品名稱,例如:騰訊形象店- image-QQ公仔; (3) H5——應(yīng)用在瀏覽器網(wǎng)頁(yè)上的場(chǎng)景,傳入瀏覽器打開(kāi)的移動(dòng)網(wǎng)頁(yè)的主頁(yè)title名-實(shí)際商品名稱,例如:騰訊充值中心-QQ會(huì)員充值; (4) 線下門店——門店品牌名-城市分店名-實(shí)際商品名稱,例如: image形象店-深圳騰大- QQ公仔) (5) APP——需傳入應(yīng)用市場(chǎng)上的APP名字-實(shí)際商品名稱,天天愛(ài)消除-游戲充值。 示例值:騰訊充值中心-QQ會(huì)員充值 |
商品詳情 | detail | string[1,6000] | 否 | 商品詳細(xì)描述,對(duì)于使用單品優(yōu)惠的商戶,改字段必須按照規(guī)范上傳,詳見(jiàn)“單品優(yōu)惠參數(shù)說(shuō)明” 示例值:440305 |
附加數(shù)據(jù) | attach | string[1,127] | 否 | 附加數(shù)據(jù),在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數(shù)據(jù) 示例值:說(shuō)明 |
商戶訂單號(hào) | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-|*且在同一個(gè)商戶號(hào)下唯一。詳見(jiàn)商戶訂單號(hào) 示例值:1217752501201407033233368018 |
貨幣類型 | fee_type | string[1,16] | 否 | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見(jiàn)貨幣類型 示例值:CNY |
總金額 | total_fee | int | 是 | 訂單總金額,只能為整數(shù),詳見(jiàn)交易金額 示例值:888 |
終端IP | spbill_create_ip | string[1,64] | 是 | 支持IPV4和IPV6兩種格式的IP地址。調(diào)用微信支付API的機(jī)器IP 示例值:123.12.12.123 |
交易起始時(shí)間 | time_start | string[1,14] | 否 | 訂單生成時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見(jiàn)時(shí)間規(guī)則 示例值:20091225091010 |
交易結(jié)束時(shí)間 | time_expire | string[1,14] | 否 | 訂單失效時(shí)間,格式為yyyyMMddHHmmss,如2009年12月27日9點(diǎn)10分10秒表示為20091227091010。訂單失效時(shí)間是針對(duì)訂單號(hào)而言的,由于在請(qǐng)求支付的時(shí)候有一個(gè)必傳參數(shù)prepay_id只有兩小時(shí)的有效期,所以在重入時(shí)間超過(guò)2小時(shí)的時(shí)候需要重新請(qǐng)求下單接口獲取新的prepay_id。其他詳見(jiàn)時(shí)間規(guī)則 示例值:20091227091010 |
訂單優(yōu)惠標(biāo)記 | goods_tag | string[1,32] | 否 | 訂單優(yōu)惠標(biāo)記,代金券或立減優(yōu)惠功能的參數(shù),說(shuō)明詳見(jiàn)代金券或立減優(yōu)惠 示例值:WXG |
付款碼 | auth_code | string[1,128] | 是 | 掃碼支付付款碼,設(shè)備讀取用戶微信中的條碼或者二維碼信息 (注:用戶付款碼條形碼規(guī)則:18位純數(shù)字,以10、11、12、13、14、15開(kāi)頭) 示例值:120061098828009406 |
指定支付方式 | limit_pay | string[1,32] | 否 | no_credit:指定不能使用信用卡支付 示例值:no_credit |
電子發(fā)票入口開(kāi)放標(biāo)識(shí) | receipt | string[1,8] | 否 | 傳入Y時(shí),支付成功消息和支付詳情頁(yè)將出現(xiàn)開(kāi)票入口。需要在微信支付商戶平臺(tái)或微信公眾平臺(tái)開(kāi)通電子發(fā)票功能,傳此字段才可生效 示例值:Y |
+ 場(chǎng)景信息 | scene_info | string[1,256] | 否 | body 該字段用于上報(bào)場(chǎng)景信息,目前支持上報(bào)實(shí)際門店信息。該字段為JSON對(duì)象數(shù)據(jù),對(duì)象格式為{"store_info":{"id": "門店ID","name": "名稱","area_code": "編碼","address": "地址" }} ,字段詳細(xì)說(shuō)明請(qǐng)點(diǎn)擊行前的+展開(kāi) 示例值:wx8888888888888888 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<attach>訂單額外描述</attach>
<auth_code>120269300684844649</auth_code>
<body>付款碼支付測(cè)試</body>
<device_info>1000</device_info>
<goods_tag></goods_tag>
<mch_id>10000100</mch_id>
<sub_mch_id>10000101</sub_mch_id>
<nonce_str>8aaee146b1dee7cec9100add9b96cbe2</nonce_str>
<out_trade_no>1415757673</out_trade_no>
<spbill_create_ip>14.17.22.52</spbill_create_ip>
<time_expire></time_expire>
<total_fee>1</total_fee>
<sign>C29DB7DB1FD4136B84AE35604756362C</sign>
</xml>
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識(shí),非交易標(biāo)識(shí),交易是否成功需要查看result_code來(lái)判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 示例值:簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時(shí)候,包含以下字段
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
應(yīng)用ID | appid | string[1,32] | 是 | 服務(wù)商商戶的APPID 示例值:wx8888888888888888 |
子商戶應(yīng)用ID | sub_appid | string[1,32] | 是 | 調(diào)用接口提交的子商戶公眾賬號(hào)ID 注意:僅適用于服務(wù)商模式 示例值:wx8888888888888888 |
商戶號(hào) | mch_id | string[1,32] | 是 | 調(diào)用接口提交的商戶號(hào) 示例值:1900000109 |
子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 調(diào)用接口提交的子商戶號(hào) 注意:僅適用于服務(wù)商模式 示例值:2100000109 |
設(shè)備號(hào) | device_info | string[1,32] | 否 | 調(diào)用接口提交的終端設(shè)備號(hào), 示例值:013467007045764 |
隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 微信返回的隨機(jī)字符串 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 微信返回的簽名,詳見(jiàn)簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值:SUCCESS |
錯(cuò)誤代碼 | err_code | string[1,32] | 否 | 詳細(xì)參見(jiàn)錯(cuò)誤列表 示例值:SYSTEMERROR |
錯(cuò)誤代碼描述 | err_code_des | string[1,128] | 否 | 結(jié)果信息描述 示例值:系統(tǒng)錯(cuò)誤 |
返回狀態(tài)碼(return_code)和業(yè)務(wù)結(jié)果(result_code)都為SUCCESS的時(shí)候,包含以下字段
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
用戶標(biāo)識(shí) | openid | string[1,128] | 否 | 用戶在主商戶appid下的唯一標(biāo)識(shí) 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否關(guān)注公眾賬號(hào) | is_subscribe | string[1,1] | 是 | 用戶是否關(guān)注公眾賬號(hào),枚舉值: Y:關(guān)注 N:未關(guān)注 (機(jī)構(gòu)商戶不返回) 示例值:Y |
用戶子標(biāo)識(shí) | sub_openid | string[1,128] | 否 | t用戶在子商戶appid下的唯一標(biāo)識(shí) 注意:僅適用于服務(wù)商模式 示例值:oUpF8uMuAJO_M2pxb1Q9zNjWeS6o |
是否關(guān)注子公眾賬號(hào) | sub_is_subscribe | string[1,1] | 否 | 用戶是否關(guān)注子公眾賬號(hào),枚舉值: Y:關(guān)注 N:未關(guān)注 (機(jī)構(gòu)商戶不返回) 示例值:Y |
交易類型 | trade_type | string[1,16] | 是 | 支付類型為MICROPAY(即掃碼支付) 示例值:MICROPAY |
付款銀行 | bank_type | string[1,32] | 是 | 銀行類型,采用字符串類型的銀行標(biāo)識(shí) 示例值:CMC |
貨幣類型 | fee_type | string[1,16] | 否 | 符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見(jiàn)貨幣類型 示例值:CNY |
總金額 | total_fee | int | 是 | 訂單總金額,只能為整數(shù),詳見(jiàn)交易金額 示例值:888 |
應(yīng)結(jié)訂單金額 | settlement_total_fee | int | 否 | 當(dāng)訂單使用了免充值型優(yōu)惠券后返回該參數(shù),應(yīng)結(jié)訂單金額=訂單金額-免充值優(yōu)惠券金額。 示例值:100 |
現(xiàn)金支付金額 | cash_fee | int | 是 | 現(xiàn)金支付金額訂單現(xiàn)金支付金額,詳見(jiàn)交易金額 示例值:100 |
現(xiàn)金支付貨幣類型 | cash_fee_type | string[1,16] | 否 | 貨幣類型,符合ISO 4217標(biāo)準(zhǔn)的三位字母代碼,默認(rèn)人民幣:CNY,其他值列表詳見(jiàn)貨幣類型 示例值:CNY |
代金券金額 | coupon_fee | int | 否 | “代金券或立減優(yōu)惠”金額<=訂單總金額,訂單總金額-“代金券或立減優(yōu)惠”金額=現(xiàn)金支付金額,詳見(jiàn)交易金額 示例值:100 |
微信支付訂單號(hào) | transaction_id | string[1,32] | 是 | 微信支付訂單號(hào) 示例值:1217752501201407033233368018 |
商戶訂單號(hào) | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號(hào),要求32個(gè)字符內(nèi),只能是數(shù)字、大小寫字母_-|*@ ,且在同一個(gè)商戶號(hào)下唯一。 示例值:1217752501201407033233368018 |
商家數(shù)據(jù)包 | attach | string[1,128] | 否 | 商家數(shù)據(jù)包,原樣返回 示例值:123456 |
支付完成時(shí)間 | time_end | string[1,14] | 是 | 訂單支付時(shí)間,格式為yyyyMMddHHmmss,如2009年12月25日9點(diǎn)10分10秒表示為20091225091010。其他詳見(jiàn)時(shí)間規(guī)則 示例值:20141030133525 |
<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>
<transaction_id><![CDATA[1008450740201411110005820873]]></transaction_id>
<out_trade_no><![CDATA[1415757673]]></out_trade_no>
<attach><![CDATA[訂單額外描述]]></attach>
<time_end><![CDATA[20141111170043]]></time_end>
</xml>
錯(cuò)誤碼 | 描述 | 解決方案 |
---|---|---|
SYSTEMERROR | 接口返回錯(cuò)誤 | 請(qǐng)立即調(diào)用被掃訂單結(jié)果查詢API,查詢當(dāng)前訂單狀態(tài),并根據(jù)訂單的狀態(tài)決定下一步的操作。 |
PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)根據(jù)接口返回的詳細(xì)信息檢查您的程序 |
ORDERPAID | 訂單已支付 | 請(qǐng)確認(rèn)該訂單號(hào)是否重復(fù)支付,如果是新單,請(qǐng)使用新訂單號(hào)提交 |
NOAUTH | 商戶無(wú)權(quán)限 | 請(qǐng)開(kāi)通商戶號(hào)權(quán)限。請(qǐng)聯(lián)系產(chǎn)品或商務(wù)申請(qǐng) |
AUTHCODEEXPIRE | 二維碼已過(guò)期,請(qǐng)用戶在微信上刷新后再試 | 請(qǐng)收銀員提示用戶,請(qǐng)用戶在微信上刷新條碼,然后請(qǐng)收銀員重新掃碼。 直接將錯(cuò)誤展示給收銀員 |
NOTENOUGH | 余額不足 | 請(qǐng)收銀員提示用戶更換當(dāng)前支付的卡,然后請(qǐng)收銀員重新掃碼。建議:商戶系統(tǒng)返回給收銀臺(tái)的提示為“用戶余額不足.提示用戶換卡支付” |
NOTSUPORTCARD | 不支持卡類型 | 請(qǐng)用戶重新選擇卡種 建議:商戶系統(tǒng)返回給收銀臺(tái)的提示為“該卡不支持當(dāng)前支付,提示用戶換卡支付或綁新卡支付” |
ORDERCLOSED | 訂單已關(guān)閉 | 商戶訂單號(hào)異常,請(qǐng)重新下單支付 |
ORDERREVERSED | 訂單已撤銷 | 當(dāng)前訂單狀態(tài)為“訂單已撤銷”,請(qǐng)?zhí)崾居脩糁匦轮Ц? |
BANKERROR | 銀行系統(tǒng)異常 | 請(qǐng)立即調(diào)用被掃訂單結(jié)果查詢API,查詢當(dāng)前訂單的不同狀態(tài),決定下一步的操作。 |
USERPAYING | 用戶支付中,需要輸入密碼 | 等待5秒,然后調(diào)用被掃訂單結(jié)果查詢API,查詢當(dāng)前訂單的不同狀態(tài),決定下一步的操作。 |
AUTH_CODE_ERROR | 付款碼參數(shù)錯(cuò)誤 | 每個(gè)二維碼僅限使用一次,請(qǐng)刷新再試 |
AUTH_CODE_INVALID | 付款碼檢驗(yàn)錯(cuò)誤 | 請(qǐng)掃描微信支付被掃條碼/二維碼 |
XML_FORMAT_ERROR | XML格式錯(cuò)誤 | 請(qǐng)檢查XML參數(shù)格式是否正確 |
REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過(guò)post方法提交 |
SIGNERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
LACK_PARAMS | 缺少參數(shù) | 請(qǐng)檢查參數(shù)是否齊全 |
NOT_UTF8 | 編碼格式錯(cuò)誤 | 請(qǐng)使用UTF-8編碼格式 |
BUYER_MISMATCH | 支付賬號(hào)錯(cuò)誤 | 請(qǐng)確認(rèn)支付方是否相同 |
APPID_NOT_EXIST | APPID不存在 | 請(qǐng)檢查APPID是否正確 |
MCHID_NOT_EXIST | MCHID不存在 | 請(qǐng)檢查MCHID是否正確 |
OUT_TRADE_NO_USED | 商戶訂單號(hào)重復(fù) | 請(qǐng)核實(shí)商戶訂單號(hào)是否重復(fù)提交 |
APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | 請(qǐng)確認(rèn)appid和mch_id是否匹配 |
INVALID_REQUEST | 無(wú)效請(qǐng)求 | 請(qǐng)確認(rèn)商戶系統(tǒng)是否正常,是否具有相應(yīng)支付權(quán)限,確認(rèn)證書是否正確,控制頻率 |
TRADE_ERROR | 交易錯(cuò)誤 | 請(qǐng)確認(rèn)賬號(hào)是否存在異常 |