# 1. 接口規(guī)則
為了在保證支付安全的前提下,帶給商戶簡單、一致且易用的開發(fā)體驗,我們推出了全新的微信支付APIv3接口。該版本API的具體規(guī)則請參考APIv3接口規(guī)則。
# 2. 開發(fā)準備
# 2.1. 搭建和配置開發(fā)環(huán)境
為了幫助開發(fā)者調(diào)用開放接口,我們提供了JAVA、PHP、GO三種語言版本的開發(fā)庫,封裝了簽名生成、簽名驗證、敏感信息加/解密、媒體文件上傳 等基礎功能(更多語言版本的開發(fā)庫將在近期陸續(xù)提供)。
測試步驟:
1、根據(jù)自身開發(fā)語言,選擇對應的開發(fā)庫并構(gòu)建項目,具體配置請參考下面鏈接的詳細說明:
- wechatpay-java (opens new window)(推薦)、wechatpay-apache-httpclient (opens new window),適用于Java開發(fā)者。
- 注:當前開發(fā)指引接口JAVA示例代碼采用wechatpay-apache-httpclient版本。
- wechatpay-php (opens new window)(推薦)、wechatpay-guzzle-middleware (opens new window),適用于PHP開發(fā)者。
- 注:當前開發(fā)指引接口PHP示例代碼采用wechatpay-guzzle-middleware版本。
- wechatpay-go (opens new window),適用于Go開發(fā)者。
更多資源可前往微信支付開發(fā)者社區(qū) (opens new window)搜索查看。
2、創(chuàng)建加載商戶私鑰、加載平臺證書、初始化httpClient的通用方法。
3、基于接口的示例代碼,替換請求參數(shù)后可發(fā)起測試。
說明:
- 上面的開發(fā)庫為微信支付官方開發(fā)庫,其它沒有審核或者控制下的第三方工具和庫,微信支付不保證它們的安全性和可靠性。通過包管理工具引入SDK后,可根據(jù)下面每個接口的示例代碼替換相關參數(shù)后進行快速測試。
- 開發(fā)者如果想詳細了解簽名生成、簽名驗證、敏感信息加/解密、媒體文件上傳等常用方法的具體代碼實現(xiàn),可閱讀下面的詳細說明:
- 如想更詳細的了解我們的接口規(guī)則,可查看我們的接口規(guī)則指引文檔。
# 3. 快速接入
# 3.1. 業(yè)務流程圖
重點步驟說明:
步驟2 用戶確認支付后,商戶調(diào)用微信支付Native下單API生成預支付交易以獲取支付二維碼鏈接code_url;
商戶調(diào)用NativeNative下單API后,分正常返回和異常返回情況:
- 正常返回: 返回code_url,商戶可根據(jù)返回的code_url來生成調(diào)用OpenSDK的簽名以執(zhí)行下一步。
- 異常返回: 返回HTTP code或錯誤碼,商戶可根據(jù)HTTP code列表 或錯誤碼說明來排查原因并執(zhí)行下一步操作。
步驟4: 商戶根據(jù)返回的code_url生成二維碼供用戶掃描,有關二維碼的規(guī)則請參考3.2.2部分的說明。
步驟9-11: 用戶支付成功后,商戶可通過以下兩種方式獲取訂單狀態(tài):
- 方法一: 支付結(jié)果通知。用戶支付成功后,微信支付會將支付成功的結(jié)果以回調(diào)通知的形式同步給商戶,商戶的回調(diào)地址需要在調(diào)用Native下單API時傳入notify_url參數(shù)。
- 方法二: 當因網(wǎng)絡抖動或本身notify_url存在問題等原因,導致無法接收到回調(diào)通知時,商戶也可主動調(diào)用查詢訂單API來獲取訂單狀態(tài)
# 3.2. API接入(含示例代碼)
本章節(jié)展示了如何使用微信支付服務端 SDK 快速接入Native支付產(chǎn)品,完成與微信支付對接的部分。
注意
- 文檔中的代碼示例是用來闡述 API 基本使用方法,代碼中的示例參數(shù)需替換成商戶自己賬號及參數(shù)才能調(diào)試成功。
- 以下接入步驟僅提供參考,請商戶結(jié)合實際業(yè)務需求進行評估、修改。
# 3.2.1. 【服務端】Native下單
步驟說明: 用戶在商戶PC網(wǎng)站內(nèi)完成商品選擇后進入支付頁面,商戶需要通過后端請求該Native下單API來獲取支付二維碼鏈接code_url。
重要入?yún)⒄f明:
- out_trade_no: 商戶系統(tǒng)內(nèi)部訂單號,只能是數(shù)字、大小寫字母_-*且在同一個商戶號下唯一
- description: 商品描述
- notify_url: 支付回調(diào)通知URL,該地址必須為直接可訪問的URL,不允許攜帶查詢串
- total: 訂單總金額,單位為分
更多參數(shù)、響應詳情及錯誤碼請參見Native下單API接口文檔。
# 3.2.2. 【客戶端】生成支付二維碼
步驟說明: 通過Native下單API成功獲取**支付二維碼鏈接(code_url)**后,需要在前端(PC網(wǎng)頁或POS機具)生成二維碼供用戶掃描支付。
注意
code_url對應鏈接格式:weixin://www.tg885.com/bizpayurl/up?pr=NwY5Mz9&groupid=00。請商戶調(diào)用第三方庫將code_url生成二維碼圖片。該模式鏈接較短,生成的二維碼打印到結(jié)賬小票上的識別率較高。
例如,weixin://www.tg885.com/bizpayurl/up?pr=NwY5Mz9&groupid=00 生成二維碼見下圖。
更多二維碼的相關背景知識可參考
# 3.2.3. 【服務端】接收支付結(jié)果通知
步驟說明: 當用戶完成支付,微信會把相關支付結(jié)果將通過異步回調(diào)的方式通知商戶,商戶需要接收處理,并按文檔規(guī)范返回應答。
注意
- 支付結(jié)果通知是以POST 方法訪問商戶設置的通知URL,通知的數(shù)據(jù)以JSON 格式通過請求主體(BODY)傳輸。通知的數(shù)據(jù)包括了加密的支付結(jié)果詳情
- 加密不能保證通知請求來自微信。微信會對發(fā)送給商戶的通知進行簽名,并將簽名值放在通知的HTTP頭Wechatpay-Signature。商戶應當驗證簽名,以確認請求來自微信,而不是其他的第三方。簽名驗證的算法請參考 《微信支付API v3簽名驗證》。
- 支付通知HTTP應答碼為200或204才會當作正常接收,當回調(diào)處理異常時,應答的HTTP狀態(tài)碼應為500,或者4xx
- 商戶成功接收到回調(diào)通知后應返回成功的HTTP應答碼為200或204
- 同樣的通知可能會多次發(fā)送給商戶系統(tǒng)。商戶系統(tǒng)必須能夠正確處理重復的通知。 推薦的做法是,當商戶系統(tǒng)收到通知進行處理時,先檢查對應業(yè)務數(shù)據(jù)的狀態(tài),并判斷該通知是否已經(jīng)處理。如果未處理,則再進行處理;如果已處理,則直接返回結(jié)果成功。在對業(yè)務數(shù)據(jù)進行狀態(tài)檢查和處理之前,要采用數(shù)據(jù)鎖進行并發(fā)控制,以避免函數(shù)重入造成的數(shù)據(jù)混亂
- 對后臺通知交互時,如果微信收到商戶的應答不符合規(guī)范或超時,微信認為通知失敗,微信會通過一定的策略定期重新發(fā)起通知,盡可能提高通知的成功率,但微信不保證通知最終能成功。(通知頻率為15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 總計 24h4m)
特別提醒: 商戶系統(tǒng)對于開啟結(jié)果通知的內(nèi)容一定要做簽名驗證,并校驗通知的信息是否與商戶側(cè)的信息一致,防止數(shù)據(jù)泄露導致出現(xiàn)“假通知”,造成資金損失。
更多參數(shù)、響應詳情及錯誤碼請參見 支付結(jié)果通知接口文檔。
# 3.2.4. 【服務端】查詢訂單
步驟說明: 當商戶后臺、網(wǎng)絡、服務器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知時,商戶可通過查詢訂單接口核實訂單支付狀態(tài)。
注意
需要調(diào)用查詢接口的情況:
- 當商戶后臺、網(wǎng)絡、服務器等出現(xiàn)異常,商戶系統(tǒng)最終未接收到支付通知。
- 調(diào)用支付接口后,返回系統(tǒng)錯誤或未知交易狀態(tài)情況。
- 調(diào)用付款碼支付API,返回USERPAYING的狀態(tài)。
- 調(diào)用關單或撤銷接口API之前,需確認支付狀態(tài)。
示例代碼(通過微信訂單號查詢):
更多參數(shù)、響應詳情及錯誤碼請參見 微信支付訂單號/商戶訂單號接口文檔。
# 3.2.5. 【服務端】關閉訂單
步驟說明: 當商戶訂單支付失敗需要生成新單號重新發(fā)起支付,要對原訂單號調(diào)用關單,避免重復支付;系統(tǒng)下單后,用戶支付超時,系統(tǒng)退出不再受理,避免用戶繼續(xù),請調(diào)用關單接口。
注意
- 關單沒有時間限制,建議在訂單生成后間隔幾分鐘(最短5分鐘)再調(diào)用關單接口,避免出現(xiàn)訂單狀態(tài)同步不及時導致關單失敗。
- 已支付成功的訂單不能關閉。
更多參數(shù)、響應詳情及錯誤碼請參見 關閉訂單接口文檔。
# 3.2.6. 【服務端】申請交易賬單
步驟說明: 微信支付按天提供交易賬單文件,商戶可以通過該接口獲取賬單文件的下載地址。
更多參數(shù)、響應詳情及錯誤碼請參見 申請交易賬單接口文檔。
# 3.2.7. 【服務端】下載賬單
步驟說明: 通過申請交易賬單接口獲取到賬單下載地址(download_url)后,再通過該接口獲取到對應的賬單文件,文件內(nèi)包含交易相關的金額、時間、營銷等信息,供商戶核對訂單、退款、銀行到賬等情況。
注意
- 賬單文件的下載地址的有效時間為30s。
- 強烈建議商戶將實際賬單文件的哈希值和之前從接口獲取到的哈希值進行比對,以確認數(shù)據(jù)的完整性。
- 該接口響應的信息請求頭中不包含微信接口響應的簽名值,因此需要跳過驗簽的流程。
- 微信在次日9點啟動生成前一天的對賬單,建議商戶10點后再獲取。
更多參數(shù)、響應詳情及錯誤碼請參見 下載賬單支付通知API接口文檔。
# 4. 常見問題
# Q:微信native支付生成的二維碼有有效期嗎?
A:一個二維碼的有效期是根據(jù)Native下單接口返回的code_url決定,code_url的有效期是2小時。
# Q:native支付掃碼后提示:支付失敗,該商戶暫不支持通過長按識別二維碼完成支付
A:微信支付已經(jīng)不支持通過長按識別二維碼的方式或通過相冊識別二維碼的方式完成支付。