最新更新時間:2021.12.21 版本說明
收銀員使用掃碼設備讀取微信用戶刷卡授權碼以后,二維碼或條碼信息傳送至商戶收銀臺,由商戶收銀臺或者商戶后臺調用該接口發(fā)起支付。
● 提交支付請求后微信會同步返回支付結果。當返回結果為“系統(tǒng)錯誤”時,商戶系統(tǒng)等待5秒后調用【查詢訂單API】,查詢支付實際交易結果;當返回結果為“USERPAYING”時,商戶系統(tǒng)可設置間隔時間(建議10秒)重新查詢支付結果,直到支付成功或超時(建議30秒);
● 在調用查詢接口返回后,如果交易狀況不明晰,請調用【撤銷訂單API】,此時如果交易失敗則關閉訂單,該單不能再支付成功;如果交易成功,則將扣款退回到用戶賬戶。當撤銷無返回或錯誤時,請再次調用。注意:請勿扣款后立即調用【撤銷訂單API】,建議至少15秒后再調用。撤銷訂單API需要雙向證書。
● 驗證密碼規(guī)則:
◆ 支付金額>1000元的交易需要驗證用戶支付密碼
◆ 用戶賬號每天最多有10筆交易可以免密,超過后需要驗證密碼
◆ 微信支付后臺判斷用戶支付行為有異常情況,符合免密規(guī)則的交易也會要求驗證密碼
注:基于一定的風控策略,存在隨時需要驗密的可能性。
適用對象:直連模式機構模式
請求URL: https://api.mch.weixin.qq.com/pay/micropay
請求方式: POST
數據格式: XML
是否需要證書: 否
參數名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
公眾賬號ID | appid | string(32) | 是 | 微信分配的公眾賬號ID 示例值:wx8888888888888888 |
子商戶公眾賬號ID | sub_appid | string(32) | 否 | 微信分配的子商戶公眾賬號ID 注意:僅適用于機構模式 示例值:1900000109 |
商戶號 | mch_id | string(32) | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶號 | sub_mch_id | string(32) | 是 | 微信支付分配的子商戶號,開發(fā)者模式下必填 注意:僅適用于機構模式 示例值:1900000109 |
設備號 | device_info | string(32) | 否 | 終端設備號(商戶自定義,如門店編號) 示例值:013467007045764 |
隨機字符串 | nonce_str | string(32) | 是 | 隨機字符串,不長于32位。推薦隨機數生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string(64) | 是 | 簽名,詳見簽名生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名類型 | sign_type | string(32) | 否 | 簽名類型,目前支持HMAC-SHA256和MD5,默認為MD5 示例值:HMAC-SHA256 |
商品描述 | body | string(32) | 是 | 商品或支付單簡要描述 示例值:Ipadmini16G白色 |
版本號 | version | string(32) | 否 | 固定值 1.0 示例值:1.0 |
商品詳情 | detail | string(6000) | 否 | 商品詳細列表,使用Json格式,傳輸簽名前請務必使用CDATA標簽將JSON文本串保護起來。 goods_detail └ goods_name string 必填 256 商品名稱 └ quantity int 必填 4 商品數量 示例值:{ "goods_detail":[ { "goods_name":"iPhone6s 16G", "quantity":1, }, { "goods_name":"iPhone6s 32G", "quantity":1, } ] } |
附加數據 | attach | string(127) | 否 | 附加數據,在查詢API和支付通知中原樣返回,該字段主要用于商戶攜帶訂單的自定義數據 示例值:說明 |
商戶訂單號 | out_trade_no | string(32) | 是 | 商戶系統(tǒng)內部訂單號,要求32個字符內,只能是數字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 其他說明見商戶訂單號 示例值:1217752501201407033233368018 |
標價金額 | total_fee | int | 是 | 標價訂單總金額,單位為分,只能為整數,詳見支付金額 示例值:888 |
標價幣種 | fee_type | string(16) | 是 | 符合ISO 4217標準的三位字母代碼,幣種列表詳見貨幣類型 示例值:USD |
終端IP | spbill_create_ip | string(64) | 是 | 符合ISO 支持IPV4和IPV6兩種格式的IP地址。調用微信支付API的機器IP 示例值:8.8.8.8 |
訂單優(yōu)惠標記 | goods_tag | string(32) | 否 | 訂單優(yōu)惠標記,代金券或立減優(yōu)惠功能的參數,說明詳見代金券或立減優(yōu)惠 示例值: |
授權碼 | auth_code | string(128) | 是 | 掃碼支付授權碼,設備讀取用戶微信中的條碼或者二維碼信息 (注:用戶刷卡條形碼規(guī)則:18位純數字,以10、11、12、13、14、15開頭) 示例值:120061098828009406 |
交易起始時間 | time_start | string(14) | 否 | 訂單生成時間,格式為yyyyMMddHHmmss,如2009年12月25日9點10分10秒表示為20091225091010。其他詳見時間規(guī)則 示例值:20091225091010 |
交易結束時間 | time_expire | string(14) | 否 | 訂單失效時間,格式為yyyyMMddHHmmss,如2009年12月27日9點10分10秒表示為20091227091010。 示例值:20091227091010 |
場景信息 | scene_info | string(256) | 否 | 該字段用于統(tǒng)一下單時上報場景信息,目前支持上報實際門店信息。 { "store_id": "", //門店唯一標識,選填,string(32) "store_name":"”//門店名稱,選填,string(64) } 示例值:{ "store_id": "SZT10000", "store_name":"騰訊大廈騰大餐廳" } |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<body>An apple</body>
<attach>Additional Order Descriptionr</attach>
<device_info>123001</device_info>
<auth_code>134539517967686076</auth_code>
<fee_type>EUR</fee_type>
<mch_id>10000100</mch_id>
<nonce_str>f6868b9b16bf4893958afd4a46d73422</nonce_str>
<out_trade_no>2017101418207317</out_trade_no>
<detail><![CDATA[{"goods_detail":[{"wxpay_goods_id":"1001","goods_name":"iPhone6s 32G","quantity":1}]}]]></detail>
<sign>5F244D7C69241AB7BC937A7A2A542294</sign>
<sub_mch_id>452532745</sub_mch_id>
<total_fee>1</total_fee>
</xml>
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string(16) | 是 | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 示例值:SUCCESS |
返回信息 | return_msg | string(128) | 否 | 返回信息,如非空,為錯誤原因 簽名失敗 參數格式校驗錯誤 示例值:簽名失敗 |
當return_code為SUCCESS的時候,還會包括以下字段:
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
公眾賬號ID | appid | string(32) | 是 | 調用接口提交的公眾賬號ID 示例值:wx8888888888888888 |
子商戶公眾賬號ID | sub_appid | string(32) | 是 | 調用接口提交的子商戶公眾賬號ID 注意:僅適用于機構模式 示例值:wx8888888888888888 |
商戶號 | mch_id | string(32) | 是 | 調用接口提交的商戶號 示例值:1900000109 |
子商戶號 | sub_mch_id | string(32) | 是 | 調用接口提交的子商戶號 注意:僅適用于機構模式 示例值:1900000109 |
設備號 | device_info | string(32) | 否 | 調用接口提交的終端設備號 示例值:013467007045764 |
隨機字符串 | nonce_str | string(32) | 是 | 微信返回的隨機字符串 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string(64) | 是 | 微信返回的簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
業(yè)務結果 | result_code | string(16) | 是 | SUCCESS/FAIL 示例值:SUCCESS |
錯誤代碼 | err_code | string(32) | 否 | 詳細參見錯誤列表 示例值:SYSTEMERROR |
錯誤代碼描述 | err_code_des | string(128) | 否 | 錯誤返回的信息描述 示例值:系統(tǒng)錯誤 |
當return_code 和result_code都為SUCCESS的時,還會包括以下字段:
字段名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
用戶標識 | openid | string(128) | 是 | 用戶在商戶appid 下的唯一標識 示例值:Y |
是否關注公眾賬號 | is_subscribe | string(1) | 是 | 用戶是否關注公眾賬號,僅在公眾賬號類型支付有效,取值范圍:Y或N;Y-關注;N-未關注 示例值:Y |
用戶子標識 | sub_openid | string(128) | 否 | 子商戶appid下用戶唯一標識,如需返回則請求時需要傳sub_appid 注意:僅適用于機構模式 示例值:Y |
是否關注子公眾賬號 | sub_is_subscribe | string(1) | 否 | 用戶是否關注子公眾賬號,僅在公眾賬號類型支付有效,取值范圍:Y或N;Y-關注;N-未關注 注意:僅適用于機構模式 示例值:Y |
交易類型 | trade_type | string(16) | 是 | 支付類型為MICROPAY(即掃碼支付) 示例值:MICROPAY |
付款銀行 | bank_type | string(32) | 是 | 銀行類型,采用字符串類型的銀行標識,值列表詳見銀行類型 示例值:CMC |
標價幣種 | fee_type | string(16) | 是 | 符合ISO 4217標準的三位字母代碼,列表詳見貨幣類型 示例值:USD |
標價金額 | total_fee | int | 是 | 訂單總金額,單位為分,只能為整數,詳見支付金額 示例值:888 |
現金支付幣種 | cash_fee_type | string(16) | 否 | 符合ISO 4217標準的三位字母代碼,列表詳見貨幣類型 示例值:USD |
現金支付金額 | cash_fee | int | 是 | 訂單現金支付金額,詳見支付金額 示例值:100 |
微信支付訂單號 | transaction_id | string(32) | 是 | 微信支付訂單號 示例值:1217752501201407033233368018 |
商戶訂單號 | out_trade_no | string(32) | 是 | 商戶系統(tǒng)內部訂單號,要求32個字符內,只能是數字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 示例值:1217752501201407033233368018 |
商家數據包 | attach | string(128) | 否 | 自定義參數,原樣返回 示例值:123456 |
支付完成時間 | time_end | string(14) | 是 | 訂單生成時間,格式為yyyyMMddHHmmss,如2009年12月25日9點10分10秒表示為20091225091010。詳見時間規(guī)則 示例值:20141030133525 |
匯率 | rate | string(16) | 是 | 標價幣種與支付幣種的兌換比例乘以10的8次方即為此值,例如美元兌換人民幣的比例為6.5,則rate=650000000 示例值:650000000 |
驗密:
<xml>
<return_code>![CDATA[SUCCESS]]</return_code>
<return_msg>![CDATA[OK]]</return_msg>
<result_code>![CDATA[FAIL]]</result_code>
<err_code_des>![CDATA[需要用戶輸入支付密碼]]</err_code_des>
<err_code>![CDATA[USERPAYING]]</err_code>
<mch_id>![CDATA[10000100]]</mch_id>
<appid>![CDATA[wx2421b1c4370ec43b]]</appid>
<sub_mch_id>![CDATA[452532745]]</sub_mch_id>
<device_info>![CDATA[123001]]</device_info>
<nonce_str>![CDATA[EBObtckqDbde2wll]]</nonce_str>
<sign>![CDATA[E0635D8F665727ACE62DEF430C22B9A4]]</sign>
</xml>
免密:
<xml>
<return_code>![CDATA[SUCCESS]]</return_code>
<return_msg>![CDATA[OK]]</return_msg>
<result_code>![CDATA[SUCCESS]]</result_code>
<mch_id>![CDATA[10000100]]</mch_id>
<appid>![CDATA[wx2421b1c4370ec43b]]</appid>
<sub_mch_id>![CDATA[375907253]]</sub_mch_id>
<device_info>![CDATA[1000]]</device_info>
<nonce_str>![CDATA[OMdoiruMjafNqdlS]]</nonce_str>
<sign>![CDATA[D460A30CDFE62F5167A0F0AE4014E5D2]]</sign>
<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>
<fee_type>![CDATA[USD]]</fee_type>
<total_fee>332</total_fee>
<cash_fee_type>![CDATA[CNY]]</cash_fee_type>
<cash_fee>2124</cash_fee>
<transaction_id>![CDATA[4200001212282111030178445712]]</transaction_id>
<out_trade_no>![CDATA[90020211103112345605049]]</out_trade_no>
<attach>![CDATA[]]</attach>
<time_end>![CDATA[20211103185407]]</time_end>
<rate>![CDATA[640053060]]</rate>
</xml>
錯誤碼 | 描述 | 問題 | 解決方案 |
---|---|---|---|
SYSTEMERROR | 接口返回錯誤 | 系統(tǒng)超時 | 請立即調用被掃訂單結果查詢API,查詢當前訂單狀態(tài),并根據訂單的狀態(tài)決定下一步的操作。 |
PARAM_ERROR | 參數錯誤 | 請求參數未按指引進行填寫 | 請根據接口返回的詳細信息檢查您的程序 |
ORDERPAID | 訂單已支付 | 訂單號重復 | 請確認該訂單號是否重復支付,如果是新單,請使用新訂單號提交 |
NOAUTH | 商戶無權限 | 商戶沒有開通被掃支付權限 | 請開通商戶號權限。請聯(lián)系產品或商務申請 |
AUTHCODEEXPIRE | 二維碼已過期,請用戶在微信上刷新后再試 | 用戶的條碼已經過期 | 請收銀員提示用戶,請用戶在微信上刷新條碼,然后請收銀員重新掃碼。 直接將錯誤展示給收銀員 |
NOTENOUGH | 余額不足 | 用戶的零錢余額不足 | 請收銀員提示用戶更換當前支付的卡,然后請收銀員重新掃碼。建議:商戶系統(tǒng)返回給收銀臺的提示為“用戶余額不足.提示用戶換卡支付” |
NOTSUPORTCARD | 不支持卡類型 | 用戶使用卡種不支持當前支付形式 | 請用戶重新選擇卡種 建議:商戶系統(tǒng)返回給收銀臺的提示為“該卡不支持當前支付,提示用戶換卡支付或綁新卡支付” |
ORDERCLOSED | 訂單已關閉 | 該訂單已關 | 商戶訂單號異常,請重新下單支付 |
ORDERREVERSED | 訂單已撤銷 | 當前訂單已經被撤銷 | 當前訂單狀態(tài)為“訂單已撤銷”,請?zhí)崾居脩糁匦轮Ц? |
BANKERROR | 銀行系統(tǒng)異常 | 銀行端超時 | 請立即調用被掃訂單結果查詢API,查詢當前訂單的不同狀態(tài),決定下一步的操作。 |
USERPAYING | 用戶支付中,需要輸入密碼 | 該筆交易因為業(yè)務規(guī)則要求,需要用戶輸入支付密碼。 | 等待5秒,然后調用被掃訂單結果查詢API,查詢當前訂單的不同狀態(tài),決定下一步的操作。 |
AUTH_CODE_ERROR | 授權碼參數錯誤 | 請求參數未按指引進行填寫 | 每個二維碼僅限使用一次,請刷新再試 |
AUTH_CODE_INVALID | 授權碼檢驗錯誤 | 收銀員掃描的不是微信支付的條碼 | 請掃描微信支付被掃條碼/二維碼 |
XML_FORMAT_ERROR | XML格式錯誤 | XML格式錯誤 | 請檢查XML參數格式是否正確 |
REQUIRE_POST_METHOD | 請使用post方法 | 未使用post傳遞參數 | 請檢查請求參數是否通過post方法提交 |
SIGNERROR | 簽名錯誤 | 參數簽名結果不正確 | 請檢查簽名參數和方法是否都符合簽名算法要求 |
LACK_PARAMS | 缺少參數 | 缺少必要的請求參數 | 請檢查參數是否齊全 |
NOT_UTF8 | 編碼格式錯誤 | 未使用指定編碼格式 | 請使用UTF-8編碼格式 |
BUYER_MISMATCH | 支付賬號錯誤 | 暫不支持同一筆訂單更換支付方 | 請確認支付方是否相同 |
APPID_NOT_EXIST | APPID不存在 | 參數中缺少APPID | 請檢查APPID是否正確 |
MCHID_NOT_EXIST | MCHID不存在 | 參數中缺少MCHID | 請檢查MCHID是否正確 |
OUT_TRADE_NO_USED | 商戶訂單號重復 | 同一筆交易不能多次提交 | 請核實商戶訂單號是否重復提交 |
APPID_MCHID_NOT_MATCH | appid和mch_id不匹配 | appid和mch_id不匹配 | 請確認appid和mch_id是否匹配 |
Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP證