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