支付寶接入接口文檔

1、支付寶接入接口文檔文檔歷史修訂日期修訂內(nèi)容修訂版修訂人本2016-08-01新建1.0李洪亮2017-05-17更新接口參數(shù)列表為全字段簽名1.1莫晉銘目錄微信支付接入接口文檔 .11 API 介紹 .31.1接口調(diào)用方式 .32 API 說明 .42.1獲取商戶開通的支付方式 .錯誤！未定義書簽。2.1.1功能描述 .錯誤！未定義書簽。2.1.2訪問地址 .錯誤！未定義書簽。2.1.3請求參數(shù) .錯誤！未定義書簽。2.1.4應(yīng)答參數(shù) .錯誤！未定義書簽。2.2掃碼支付接口 (商戶掃消費者 ) .42.2.1功能描述 .42.2.2訪問地址 .42.2.3請求參數(shù) .42.2.4應(yīng)答參數(shù) .5

2、2.3消費撤銷 .52.3.1功能描述 .52.3.2訪問地址 .52.3.3請求參數(shù) .52.3.4應(yīng)答參數(shù) .62.4消費退款 .錯誤！未定義書簽。2.4.1功能描述 .錯誤！未定義書簽。2.4.2訪問地址 .錯誤！未定義書簽。2.4.3請求參數(shù) .錯誤！未定義書簽。2.4.4應(yīng)答參數(shù) .錯誤！未定義書簽。2.5已退款訂單查詢 .62.5.1功能描述 .錯誤！未定義書簽。2.5.2訪問地址 .錯誤！未定義書簽。2.5.3請求參數(shù) .錯誤！未定義書簽。2.5.4應(yīng)答參數(shù) .錯誤！未定義書簽。2.6訂單查詢 .62.6.1功能描述 .62.6.2訪問地址 .62.6.3請求參數(shù) .62.6.4

3、應(yīng)答參數(shù) .62.7掃碼支付 (消費者掃商戶 ). 62.7.1功能描述 .72.7.2訪問地址 .72.7.3請求參數(shù) .72.7.4應(yīng)答參數(shù) .72.8通莞金服支付結(jié)果通知 .92.8.1功能描述 .92.8.2訪問地址 .92.8.3請求參數(shù) .92.8.4響應(yīng)參數(shù) .103 附錄.103.1訂單詳情 OrderInfo錯誤！未定義書簽。3.2簽名 sign 算法 .101 API 介紹1.1 文檔說明及接口調(diào)用方式API 調(diào)用方式與說明：所有均采用HTTP方式訪問，請求參數(shù)和應(yīng)答參數(shù)類型為json 格式提交方法 POST，編碼為UTF-8測試信息：請聯(lián)系相關(guān)接入人員。接口應(yīng)答參數(shù)中st

4、atus和 message 字段不為空， status為本次接口訪問的結(jié)果標(biāo)志， message 為結(jié)果的描述。100 代表成功，其余編碼為失敗，擁有一系列不同的失敗編碼，并有相應(yīng)的message 描述。當(dāng)status為成功編碼時。為了防止數(shù)據(jù)在傳輸過程中被抓包或者篡改，每個接口需要算出簽名字段sign ，每個接口參與算簽名的參數(shù)字段都不一樣，接口參數(shù)列表里“簽名”列為“Y”則表示此參數(shù)需要參與到簽名sign 。有關(guān)簽名算法參見附錄。接口列表2.1 掃碼支付接口 (被掃模式 )功能描述商戶使用終端機具或者掃碼槍等掃描消費者付款碼進行支付，此種屬于被掃模式。訪問地址正式環(huán)境請求URL：測試環(huán)境請

5、求URL：請求參數(shù)字段名中文名類型簽名必傳說明account商戶進件手機號StringYY商戶進件手機號payMoney支付金額StringYY單位：元lowOrderId下游訂單號StringYY下游訂單號barcode付款碼StringYY消費者付款碼信息body商品描述StringYN商品描述sign簽名StringY簽名payType支付方式StringYY支付方式0 ：微信， 1：支付寶應(yīng)答參數(shù)字段名中文名類型簽名必傳說明status結(jié)果stringYY100: 成功， 101：失敗message結(jié)果描述stringYY錯誤信息描述lowOrderId下游訂單號StringYY下游訂

6、單號payMoney支付金額StringYY單位：元account商戶進件手機號StringYY商戶進件手機號UpOrderId通莞金服訂單號StringYY通莞金服訂單號state訂單實際支付狀態(tài)StringYY0：成功， 1：失敗， 2：已撤銷sign簽名StringY簽名2.2 消費撤銷功能描述針對支付成功的交易，可以調(diào)用此接口撤銷原交易。支付完成時間超過四分鐘請調(diào)用退款接口訪問地址正式環(huán)境請求URL：測試環(huán)境請求URL：請求參數(shù)字段名中文名類型簽名必傳說明account商戶進件手機號StringYY商戶進件手機號upOrderId通莞金服訂單號StringYY通莞金服訂單號lowOrd

7、erId下游訂單號StringYY下游訂單號sign簽名StringY簽名應(yīng)答參數(shù)字段名中文名類型簽名必傳說明status結(jié)果stringYY100: 成功， 101：失敗message結(jié)果描述stringYY錯誤信息描述account商戶進件手機號StringYY商戶進件手機號upOrderId通莞金服訂單號StringYY通莞金服訂單號lowOrderId下游訂單號StringYY下游訂單號state訂單實際狀態(tài)StringYY0：成功， 1：失敗， 2：已撤銷sign簽名StringY簽名2.3 訂單查詢功能描述用訂單號查詢訂單詳情， 此接口中下游訂單號lowOrderId 與通莞金服訂

8、單號upOrderId二選一。訪問地址正式環(huán)境請求URL：測試環(huán)境請求URL：請求參數(shù)字段名中文名類型簽名必傳說明account商戶進件手機號StringYY商戶進件手機號lowOrderId下游訂單號StringYY下游訂單號upOrderId通莞金服訂單號String通莞金服訂單號sign簽名StringY簽名應(yīng)答參數(shù)字段名中文名類型簽名必傳說明status結(jié)果stringYY100: 成功， 101：失敗message結(jié)果描述stringYY錯誤信息描述lowOrderId下游訂單號StringYY下游訂單號payMoney支付金額StringYY單位：元account商戶進件手機號St

9、ringYY商戶進件手機號upOrderId通莞金服訂單號StringYY通莞金服訂單號state訂單實際支付狀態(tài)StringYY0：成功， 1：失敗， 2：已撤銷sign簽名StringY簽名2.4 掃碼支付 (主掃模式 )功能描述終端機具生成訂單二維碼讓消費者掃，掃碼后輸入密碼即完成支付。訪問地址正式環(huán)境請求URL：測試環(huán)境請求URL：請求參數(shù)字段名中文名類型簽名必傳說明account商戶進件手機號StringYY商戶進件手機號payMoney支付金額StringYY單位：元body商品訂單描述StringYN商品訂單描述lowOrderId下游流水號StringYY流水號notifyUr

10、l下游回調(diào)地址StringYY下游接收支付結(jié)果的url 地址sign簽名StringY簽名，算法參見附錄payType支付方式StringYY支付方式 0 ：微信， 1：支付寶應(yīng)答參數(shù)字段名中文名類型簽名必傳說明status結(jié)果stringYY100: 成功， 101：失敗message結(jié)果描述stringYY錯誤信息描述codeUrl訂單二維碼 urlstringYY訂單二維碼 urllowOrderId下游流水號StringYY流水號account商戶進件手機號StringYY商戶進件手機號sign簽名StringY簽名，算法參見附錄2.5 支付結(jié)果通知功能描述通莞金服在消費者支付完成之后

11、將訂單支付結(jié)果通知到下游系統(tǒng)，通知內(nèi)容為json 字符串，字段內(nèi)容如請求參數(shù)所列。訪問地址正式環(huán)境請求URL：測試環(huán)境請求URL：請求參數(shù)字段名中文名類型簽名必傳說明lowOrderId下游系統(tǒng)流水號StringYY必須唯一merchantId通莞金服商戶號StringYY通莞金服商戶號payMoney支付金額StringYY單位：元upOrderId通莞金服流水號StringYY通莞金服流水號state訂單狀態(tài)StringYY0：成功， 1：失敗。orderDesc訂單描述StringYY狀態(tài)為失敗時，表示失敗原因sign簽名StringY簽名， 算法參見附錄響應(yīng)參數(shù)字段名中文名類型簽名必傳

12、說明lowOrderId下游系統(tǒng)流水號StringYY必須唯一merchantId通莞金服商戶號StringYY通莞金服商戶號finished是否收到回調(diào)StringYYSUCCESS表示成功， 其他的失敗upOrderId上游流水號StringYY上游流水號sign簽名StringY簽名， 算法參見附錄2.6 退款接口功能描述一、退款方式 目前只支持原路返回退款說明：退到銀行卡則是非實時的，每個銀行的處理速度不同，一般發(fā)起退款后1-5 個工作日內(nèi)到賬, 總退款金額不能超過用戶實際支付金額( 現(xiàn)金券金額不能退款)二、退款限制 商戶在退款操作時應(yīng)該注意退款限制，避免發(fā)起不會成功的退款請求，下面是

13、主要的退款限制： 只要退款累計金額不超過交易單支付總額，一筆交易單可以多次退款，退款申請單號 （退款接口中有此參數(shù)）唯一確定一次退款， 而不是交易單號確定一次退款。退款申請單號由商戶生成，所以商戶一定要保證退款申請單的唯一性。商家在退款過程中要特別注意， 只有在能確定退款失敗的情況下，才能 重新發(fā)起另一筆退款。 2.目前大多數(shù)銀行都支持全額退款和部分退款，但是也有少數(shù)銀行不支持全額退款或部分退款，或者不支持退款。在這種情況下，商戶可以與買家協(xié)調(diào)，退到微信余額賬戶中訪問地址正式環(huán)境請求URL：測試環(huán)境請求URL：請求參數(shù)字段名中文名類型簽名必傳說明lowOrderId下游系統(tǒng)流水號StringY

14、Y必須唯一merchantId通莞金服商戶號StringYY通莞金服商戶號payMoney支付金額StringYY單位：元upOrderId通莞金服流水號StringYY通莞金服流水號state訂單狀態(tài)StringYY0：成功， 1：失敗。orderDesc訂單描述StringYY狀態(tài)為失敗時，表示失敗原因sign簽名StringY簽名， 算法參見附錄響應(yīng)參數(shù)字段名中文名類型簽名必傳說明lowOrderId下游系統(tǒng)流水號StringYY必須唯一merchantId通莞金服商戶號StringYY通莞金服商戶號finished是否收到回調(diào)StringYYSUCCESS表示成功， 其他的失敗upOrderId上游流水號StringYY上游流水號sign簽名StringY簽名， 算法參見附錄附錄3.1 簽名 sign 算法每個接口的參數(shù)對應(yīng)的“簽名”列的內(nèi)容為“Y”時，表示該字段參與簽名，按照字母升