一、設置支付目錄:
登錄微信支付商戶平臺(pay.weixin.qq.com)-->產品中心-->開發配置,設置後一般5分鐘內生效。
二、設置授權域名:
開發JSAPI支付時,在統一下單接口中要求必傳用戶openid,而獲取openid則需要您在公衆平臺設置獲取openid的域名,只有被設置過的域名纔是一個有效的獲取openid的域名,否則將獲取失敗。
參數解釋:
郵件中參數 | API參數名 | 詳細說明 |
---|---|---|
APPID | appid | appid是微信公衆賬號或開放平臺APP的唯一標識,在公衆平臺申請公衆賬號或者在開放平臺申請APP賬號後,微信會自動分配對應的appid,用於標識該應用。可在微信公衆平臺-->開發-->基本配置裏面查看,商戶的微信支付審覈通過郵件中也會包含該字段值。 |
微信支付商戶號 | mch_id | 商戶申請微信支付後,由微信支付分配的商戶收款賬號。 |
API密鑰 | key | 交易過程生成簽名的密鑰,僅保留在商戶系統和微信支付後臺,不會在網絡中傳播。商戶妥善保管該Key,切勿在網絡中傳輸,不能在其他客戶端中存儲,保證key不會被泄漏。商戶可根據郵件提示登錄微信商戶平臺進行設置。也可按以下路徑設置:微信商戶平臺(pay.weixin.qq.com)-->賬戶中心-->賬戶設置-->API安全-->密鑰設置 |
Appsecret | secret | AppSecret是APPID對應的接口密碼,用於獲取接口調用憑證access_token時使用。在微信支付中,先通過OAuth2.0接口獲取用戶openid,此openid用於微信內網頁支付模式下單接口使用。可登錄公衆平臺-->微信支付,獲取AppSecret(需成爲開發者且帳號沒有異常狀態)。 |
1. 通過APPID獲取code:
請求網址:
https://open.weixin.qq.com/connect/oauth2/authorize?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=snsapi_base&state=STATE#wechat_redirect
參數 | 是否必須 | 說明 |
---|---|---|
appid | 是 | 公衆號的唯一標識 |
redirect_uri | 是 | 授權後重定向的回調鏈接地址, 請使用 urlEncode 對鏈接進行處理 |
response_type | 是 | 返回類型,請填寫code |
scope | 是 | 應用授權作用域,snsapi_base (不彈出授權頁面,直接跳轉,只能獲取用戶openid) |
state | 否 | 重定向後會帶上state參數,開發者可以填寫a-zA-Z0-9的參數值,最多128字節 |
#wechat_redirect | 是 | 無論直接打開還是做頁面302重定向時候,必須帶此參數 |
2. 通過code換取網頁授權access_token及openid:
請求網址:
https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code
參數說明
參數 | 是否必須 | 說明 |
---|---|---|
appid | 是 | 公衆號的唯一標識 |
secret | 是 | 公衆號的appsecret |
code | 是 | 填寫第一步獲取的code參數 |
grant_type | 是 | 填寫爲authorization_code |
3. 統一下單:
請求地址:https://api.mch.weixin.qq.com/pay/unifiedorder
請求參數
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公衆賬號ID | appid | 是 | String(32) | wxd678efh567hg6787 | 微信支付分配的公衆賬號ID(企業號corpid即爲此appId) |
商戶號 | mch_id | 是 | String(32) | 1230000109 | 微信支付分配的商戶號 |
設備號 | device_info | 否 | String(32) | 013467007045764 | 自定義參數,可以爲終端設備號(門店號或收銀設備ID),PC網頁或公衆號內支付可以傳"WEB" |
隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串,長度要求在32位以內。推薦隨機數生成算法 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 通過簽名算法計算得出的簽名值,詳見簽名生成算法 |
簽名類型 | sign_type | 否 | String(32) | MD5 | 簽名類型,默認爲MD5,支持HMAC-SHA256和MD5。 |
商品描述 | body | 是 | String(128) | 騰訊充值中心-QQ會員充值 |
商品簡單描述,該字段請按照規範傳遞,具體請見參數規定 |
商品詳情 | detail | 否 | String(6000) | 商品詳細描述,對於使用單品優惠的商戶,該字段必須按照規範上傳,詳見“單品優惠參數說明” | |
附加數據 | attach | 否 | String(127) | 深圳分店 | 附加數據,在查詢API和支付通知中原樣返回,可作爲自定義參數使用。 |
商戶訂單號 | out_trade_no | 是 | String(32) | 20150806125346 | 商戶系統內部訂單號,要求32個字符內,只能是數字、大小寫字母_-|* 且在同一個商戶號下唯一。詳見商戶訂單號 |
標價幣種 | fee_type | 否 | String(16) | CNY | 符合ISO 4217標準的三位字母代碼,默認人民幣:CNY,詳細列表請參見貨幣類型 |
標價金額 | total_fee | 是 | Int | 88 | 訂單總金額,單位爲分,詳見支付金額 |
終端IP | spbill_create_ip | 是 | String(64) | 123.12.12.123 | 支持IPV4和IPV6兩種格式的IP地址。用戶的客戶端IP |
交易起始時間 | time_start | 否 | String(14) | 20091225091010 | 訂單生成時間,格式爲yyyyMMddHHmmss,如2009年12月25日9點10分10秒錶示爲20091225091010。其他詳見時間規則 |
交易結束時間 | time_expire | 否 | String(14) | 20091227091010 |
訂單失效時間,格式爲yyyyMMddHHmmss,如2009年12月27日9點10分10秒錶示爲20091227091010。訂單失效時間是針對訂單號而言的,由於在請求支付的時候有一個必傳參數prepay_id只有兩小時的有效期,所以在重入時間超過2小時的時候需要重新請求下單接口獲取新的prepay_id。其他詳見時間規則 time_expire只能第一次下單傳值,不允許二次修改,二次修改系統將報錯。如用戶支付失敗後,需再次支付,需更換原訂單號重新下單。建議:最短失效時間間隔大於1分鐘 |
訂單優惠標記 | goods_tag | 否 | String(32) | WXG | 訂單優惠標記,使用代金券或立減優惠功能時需要的參數,說明詳見代金券或立減優惠 |
通知地址 | notify_url | 是 | String(256) | http://www.weixin.qq.com/wxpay/pay.php | 異步接收微信支付結果通知的回調地址,通知url必須爲外網可訪問的url,不能攜帶參數。 |
交易類型 | trade_type | 是 | String(16) | JSAPI |
JSAPI -JSAPI支付 NATIVE -Native支付 APP -APP支付 說明詳見參數規定 |
商品ID | product_id | 否 | String(32) | 12235413214070356458058 | trade_type=NATIVE時,此參數必傳。此參數爲二維碼中包含的商品ID,商戶自行定義。 |
指定支付方式 | limit_pay | 否 | String(32) | no_credit | 上傳此參數no_credit--可限制用戶不能使用信用卡支付 |
用戶標識 | openid | 否 | String(128) | oUpF8uMuAJO_M2pxb1Q9zNjWeS6o | trade_type=JSAPI時(即JSAPI支付),此參數必傳,此參數爲微信用戶在商戶對應appid下的唯一標識。openid如何獲取,可參考【獲取openid】。企業號請使用【企業號OAuth2.0接口】獲取企業號內成員userid,再調用【企業號userid轉openid接口】進行轉換 |
電子發票入口開放標識 | receipt | 否 | String(8) | Y | Y,傳入Y時,支付成功消息和支付詳情頁將出現開票入口。需要在微信支付商戶平臺或微信公衆平臺開通電子發票功能,傳此字段纔可生效 |
+場景信息 | scene_info | 否 | String(256) |
{"store_info" : { |
該字段常用於線下活動時的場景信息上報,支持上報實際門店信息,商戶也可以按需求自己上報相關信息。該字段爲JSON對象數據,對象格式爲{"store_info":{"id": "門店ID","name": "名稱","area_code": "編碼","address": "地址" }} ,字段詳細說明請點擊行前的+展開 |
舉例如下:
<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>
注:參數值用XML轉義即可,CDATA標籤用於說明數據不被XML解析器解析。
返回結果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態碼 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 |
返回信息 | return_msg | 是 | String(128) | OK |
當return_code爲FAIL時返回信息爲錯誤原因 ,例如 簽名失敗 參數格式校驗錯誤 |
以下字段在return_code爲SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
公衆賬號ID | appid | 是 | String(32) | wx8888888888888888 | 調用接口提交的公衆賬號ID |
商戶號 | mch_id | 是 | String(32) | 1900000109 | 調用接口提交的商戶號 |
設備號 | device_info | 否 | String(32) | 013467007045764 | 自定義參數,可以爲請求支付的終端設備號等 |
隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 微信返回的隨機字符串 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 微信返回的簽名值,詳見簽名算法 |
業務結果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
錯誤代碼 | err_code | 否 | String(32) | 當result_code爲FAIL時返回錯誤代碼,詳細參見下文錯誤列表 | |
錯誤代碼描述 | err_code_des | 否 | String(128) | 當result_code爲FAIL時返回錯誤描述,詳細參見下文錯誤列表 |
以下字段在return_code 和result_code都爲SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
交易類型 | trade_type | 是 | String(16) | JSAPI |
JSAPI -JSAPI支付 NATIVE -Native支付 APP -APP支付 說明詳見參數規定 |
預支付交易會話標識 | prepay_id | 是 | String(64) | wx201410272009395522657a690389285100 | 微信生成的預支付會話標識,用於後續接口調用中使用,該值有效期爲2小時 |
二維碼鏈接 | code_url | 否 | String(64) | weixin://wxpay/bizpayurl/up?pr=NwY5Mz9&groupid=00 |
trade_type=NATIVE時有返回,此url用於生成支付二維碼,然後提供給用戶進行掃碼支付。 注意:code_url的值並非固定,使用時按照URL格式轉成二維碼即可 |
4. 支付結果通知
支付完成後,微信會把相關支付結果及用戶信息通過數據流的形式發送給商戶
回調鏈接是通過【統一下單API】中提交的參數notify_url設置,如果鏈接無法訪問,商戶將無法接收到微信通知。通知url必須爲直接可訪問的url,不能攜帶參數。示例:notify_url:“https://pay.weixin.qq.com/wxpay/pay.action”
注意:
1、同樣的通知可能會多次發送給商戶系統。商戶系統必須能夠正確處理重複的通知。
2、後臺通知交互時,如果微信收到商戶的應答不符合規範或超時,微信會判定本次通知失敗,重新發送通知,直到成功爲止(在通知一直不成功的情況下,微信總共會發起多次通知,通知頻率爲15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 總計 24h4m),但微信不保證通知最終一定能成功。
3、在訂單狀態不明或者沒有收到微信支付結果通知的情況下,建議商戶主動調用微信支付【查詢訂單API】確認訂單狀態。
特別提醒:
1、商戶系統對於支付結果通知的內容一定要做簽名驗證,並校驗返回的訂單金額是否與商戶側的訂單金額一致,防止數據泄漏導致出現“假通知”,造成資金損失。
2、當收到通知進行處理時,首先檢查對應業務數據的狀態,判斷該通知是否已經處理過,如果沒有處理過再進行處理,如果處理過直接返回結果成功。在對業務數據進行狀態檢查和處理之前,要採用數據鎖進行併發控制,以避免函數重入造成的數據混亂。
通知參數
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態碼 | return_code | 是 | String(16) | SUCCESS |
SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 |
返回信息,如非空,爲錯誤原因 簽名失敗 參數格式校驗錯誤 |
以下字段在return_code爲SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
小程序ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的小程序ID |
商戶號 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號 |
設備號 | device_info | 否 | String(32) | 013467007045764 | 微信支付分配的終端設備號, |
隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串,不長於32位 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名,詳見簽名算法 |
簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型,目前支持HMAC-SHA256和MD5,默認爲MD5 |
業務結果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
錯誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 錯誤返回的信息描述 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 系統錯誤 | 錯誤返回的信息描述 |
用戶標識 | openid | 是 | String(128) | wxd930ea5d5a258f4f | 用戶在商戶appid下的唯一標識 |
是否關注公衆賬號 | is_subscribe | 是 | String(1) | Y | 用戶是否關注公衆賬號,Y-關注,N-未關注 |
交易類型 | trade_type | 是 | String(16) | JSAPI | JSAPI、NATIVE、APP |
付款銀行 | bank_type | 是 | String(32) | CMC | 銀行類型,採用字符串類型的銀行標識,銀行類型見銀行列表 |
訂單金額 | total_fee | 是 | Int | 100 | 訂單總金額,單位爲分 |
應結訂單金額 | settlement_total_fee | 否 | Int | 100 | 應結訂單金額=訂單金額-非充值代金券金額,應結訂單金額<=訂單金額。 |
貨幣種類 | fee_type | 否 | String(8) | CNY | 貨幣類型,符合ISO4217標準的三位字母代碼,默認人民幣:CNY,其他值列表詳見貨幣類型 |
現金支付金額 | cash_fee | 是 | Int | 100 | 現金支付金額訂單現金支付金額,詳見支付金額 |
現金支付貨幣類型 | cash_fee_type | 否 | String(16) | CNY | 貨幣類型,符合ISO4217標準的三位字母代碼,默認人民幣:CNY,其他值列表詳見貨幣類型 |
總代金券金額 | coupon_fee | 否 | Int | 10 | 代金券金額<=訂單金額,訂單金額-代金券金額=現金支付金額,詳見支付金額 |
代金券使用數量 | coupon_count | 否 | Int | 1 | 代金券使用數量 |
代金券類型 | coupon_type_$n | 否 | String | CASH |
CASH--充值代金券 NO_CASH---非充值代金券 並且訂單使用了免充值券後有返回(取值:CASH、NO_CASH)。$n爲下標,從0開始編號,舉例:coupon_type_0 注意:只有下單時訂單使用了優惠,回調通知纔會返回券信息。下列情況可能導致訂單不可以享受優惠:可能情況。 |
代金券ID | coupon_id_$n | 否 | String(20) | 10000 | 代金券ID,$n爲下標,從0開始編號 注意:只有下單時訂單使用了優惠,回調通知纔會返回券信息。 下列情況可能導致訂單不可以享受優惠:可能情況。 |
單個代金券支付金額 | coupon_fee_$n | 否 | Int | 100 | 單個代金券支付金額,$n爲下標,從0開始編號 |
微信支付訂單號 | transaction_id | 是 | String(32) | 1217752501201407033233368018 | 微信支付訂單號 |
商戶訂單號 | out_trade_no | 是 | String(32) | 1212321211201407033568112322 | 商戶系統內部訂單號,要求32個字符內,只能是數字、大小寫字母_-|*@ ,且在同一個商戶號下唯一。 |
商家數據包 | attach | 否 | String(128) | 123456 | 商家數據包,原樣返回 |
支付完成時間 | time_end | 是 | String(14) | 20141030133525 | 支付完成時間,格式爲yyyyMMddHHmmss,如2009年12月25日9點10分10秒錶示爲20091225091010。其他詳見時間規則 |
舉例如下:
<xml>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<attach><![CDATA[支付測試]]></attach>
<bank_type><![CDATA[CFT]]></bank_type>
<fee_type><![CDATA[CNY]]></fee_type>
<is_subscribe><![CDATA[Y]]></is_subscribe>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[5d2b6c2a8db53831f7eda20af46e531c]]></nonce_str>
<openid><![CDATA[oUpF8uMEb4qRXf22hE3X68TekukE]]></openid>
<out_trade_no><![CDATA[1409811653]]></out_trade_no>
<result_code><![CDATA[SUCCESS]]></result_code>
<return_code><![CDATA[SUCCESS]]></return_code>
<sign><![CDATA[B552ED6B279343CB493C5DD0D78AB241]]></sign>
<time_end><![CDATA[20140903131540]]></time_end>
<total_fee>1</total_fee>
<coupon_fee><![CDATA[10]]></coupon_fee>
<coupon_count><![CDATA[1]]></coupon_count>
<coupon_type><![CDATA[CASH]]></coupon_type>
<coupon_id><![CDATA[10000]]></coupon_id>
<coupon_fee><![CDATA[100]]></coupon_fee>
<trade_type><![CDATA[JSAPI]]></trade_type>
<transaction_id><![CDATA[1004400740201409030005092168]]></transaction_id>
</xml>