最新更新時間:2020.10.10 版本說明
商戶可以通過該接口拉取用戶在微信支付交易記錄中針對你的支付記錄進行的評價內容。
商戶可結合商戶系統(tǒng)邏輯對該內容數(shù)據(jù)進行存儲、分析、展示、客服回訪以及其他使用。如商戶業(yè)務對評價內容有依賴,可主動引導用戶進入微信支付交易記錄進行評價。
1. 該內容所有權為提供內容的微信用戶,商戶在使用內容的過程中應遵從用戶意愿
2. 一次最多拉取200條評價數(shù)據(jù),可根據(jù)時間區(qū)間分批次拉取
3. 接口只能拉取最近三個月以內的評價數(shù)據(jù)
適用對象:直連商戶 服務商
請求URL: https://api.mch.weixin.qq.com/billcommentsp/batchquerycomment
請求方式: POST
數(shù)據(jù)格式: XML
是否需要證書: 是
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
應用ID | appid | string[1,32] | 是 | 微信分配的應用ID 示例值:wx8888888888888888 |
商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值:1900000109 |
子商戶應用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應用ID,如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意:僅適用于服務商模式 示例值:wx8888888888888888 |
子商戶號 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號 注意:僅適用于服務商模式 示例值:1900000109 |
隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串,不長于32位。推薦隨機數(shù)生成算法 示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
簽名 | sign | string[1,64] | 是 | 簽名,詳見簽名生成算法 示例值:C380BEC2BFD727A4B6845133519F3AD6 |
簽名類型 | sign_type | string[1,32] | 否 | 簽名類型,目前僅支持HMAC-SHA256,默認就是HMAC-SHA256 示例值:HMAC-SHA256 |
開始時間 | begin_time | string[1,19] | 是 | 按用戶評論時間批量拉取的起始時間,格式為yyyyMMddHHmmss 示例值:20170724000000 |
結束時間 | end_time | string[1,19] | 是 | 按用戶評論時間批量拉取的結束時間,格式為yyyyMMddHHmmss 示例值:20170724500000 |
位移 | offset | uint64 | 是 | 指定從某條記錄的下一條開始返回記錄。接口調用成功時,會返回本次查詢最后一條數(shù)據(jù)的offset。商戶需要翻頁時,應該把本次調用返回的offset 作為下次調用的入?yún)ⅰW⒁鈕ffset是評論數(shù)據(jù)在微信支付后臺保存的索引,未必是連續(xù)的 示例值:0 |
條數(shù) | limit | uint32 | 否 | 一次拉取的條數(shù), 最大值是200,默認是200 示例值:200 |
<xml>
<appid>wxe062425f740c30d8</appid>
<mch_id>1900000109</mch_id>
<nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
<offset>0</offset>
<limit>100</limit>
<begin_time>20170724000000</begin_time>
<end_time>20170725000000</end_time>
<sign_type>HMAC-SHA256</sign_type>
<sign>3AE1368BD96B4644FA5823E024CFE938F1B852EFA87919EDDEE324AE24C8C04F</sign>
</xml>
失敗時,返回以下字段
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 示例值:SUCCESS |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 示例值:簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時候,包含以下字段,進一步返回以下字段指明業(yè)務失敗的原因
參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
---|---|---|---|---|
業(yè)務結果 | result_code | string[1,16] | 是 | FAIL 此字段是業(yè)務標識,表示業(yè)務是否成功。目前只在失敗時返回這個字段,所以只會出現(xiàn)FAIL值 示例值:FAIL |
錯誤代碼 | err_code | string[1,16] | 是 | 見錯誤碼列表 示例值:SYSTEMERROR |
錯誤代碼描述 | err_code_des | string[1,128] | 否 | 錯誤信息描述 示例值:簽名失敗 |
<xml>
<return_code><![CDATA[FAIL]]></return_code>
<return_msg><![CDATA[商戶證書錯誤]]></return_msg>
</xml>
成功時,數(shù)據(jù)以文本表格的方式返回
第一行返回當前查詢到的數(shù)據(jù)最后一條的offset
從第二行開始,每一行表示一筆交易單的評論信息,各參數(shù)以逗號隔開, 參數(shù)前增加`符號,為標準鍵盤1左邊鍵的字符。參數(shù)內容依次為:評論的時間,支付訂單號,評論星級,評論內容
舉例如下:
100
`2017-07-01 10:00:05,` 1001690740201411100005734289,`5,`贊,水果很新鮮
`2017-07-01 11:00:05,` 1001690740201411100005734278,`5,`不錯,支付渠道很方便
`2017-07-01 11:30:05,` 1001690740201411100005734250,`4,`東西還算符合預期
錯誤碼 | 描述 | 解決方案 |
---|---|---|
SYSTEMERROR | 微信支付內部錯誤 | 請稍后重試 |
NO_COMMENT | 對應的時間段沒有用戶的評論數(shù)據(jù) | 請查詢其他時間段的評論數(shù)據(jù) |
TIME_EXPIRE | 拉取的時間超過3個月 | 請拉取90天內的數(shù)據(jù) |
PARAM_ERROR | 參數(shù)錯誤 | 請對照文檔的請求參數(shù)說明檢查參數(shù) |