銀行特約商戶違規(guī)信息查詢API
應用場景
方便銀行服務商查詢特約商戶違規(guī)記錄
接口鏈接
URL地址:https://api.mch.weixin.qq.com/risk/getviolation
是否需要證書
是
請求參數(shù)
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
商戶號 | mch_id | 是 | String(32) | 1230000110 | 銀行服務商、從業(yè)機構、渠道商的商戶號 |
隨機字符串 |
nonce_str |
是 |
String(32) |
5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
隨機字符串,不長于32位 |
簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 通過簽名算法計算得出的簽名值,詳見簽名生成算法 |
簽名類型 | sign_type | 是 | String(32) | HMAC-SHA256 | 簽名類型 |
開始時間 | begin_time | 是 | String(32) | 2020-05-11 10:10:00 | 格式:yyyy-mm-dd HH:MM:SS 結束時間和開始時間的區(qū)間不超過30天,超出后會返回失敗 |
結束時間 | end_time | 是 | String(32) | 2020-05-11 10:10:00 | 格式:yyyy-mm-dd HH:MM:SS 結束時間和開始時間的區(qū)間不超過30天,超出后會返回失敗 |
頁碼 | page_index | 是 | String(10) | 1 | 當前查詢的具體分頁頁碼 |
每頁返回的數(shù)量 | page_size | 是 | String(10) | 10 | 該參數(shù)可設置每頁返回內(nèi)容的最大條數(shù),最大不超過50 |
違規(guī)記錄數(shù)據(jù)格式 | violation_records_format | 是 | String(10) | csv | csv:返回數(shù)據(jù)包是文本格式,使用逗號分隔 json:返回的violation_records字段是json格式,詳見返回參數(shù) |
1.商戶簡稱長度為中文字符個數(shù),其他均為字節(jié)數(shù)
2.參數(shù)值用XML轉義或加CDATA標簽用于說明數(shù)據(jù)不被XML解析器解析。
<xml>
<mch_id>123456</mch_id>
<nonce_str>5087e0xessefellkg</nonce_str>
<sign>xxxxxx</sign>
<sign_type>HMAC-SHA256</sign_type>
<begin_time>2017-07-02 0:0:0</begin_time>
<end_time>2017-07-29 23:59:59</end_time>
</xml>
返回結果
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信標識,非交易標識,交易是否成功需要查看result_code來判斷 |
返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息,如非空,為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 |
錯誤代碼 | err_code | 否 | String(32) | INVALID_REQUEST | 錯誤代碼 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 商戶號信息有誤,請檢查修改后重試 | 結果信息描述 |
<xml>
<return_code><![CDATA[FAIL]]></return_code>
<return_msg><![CDATA[INVALID_REQUEST]]></return_msg>
</xml>
以下字段在return_code為SUCCESS的時候有返回
字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
---|---|---|---|---|---|
處理結果 | result_code | 是 | String(32) | FAIL | SUCCESS/FAIL |
處理信息 | result_msg | 是 | String(32) | 參數(shù)錯誤 | 結果信息描述。處理成功,錯誤原因提示等 |
錯誤代碼 | err_code | 否 | String(32) | INVALID_REQUEST | 錯誤代碼 |
錯誤代碼描述 | err_code_des | 否 | String(128) | 商戶號信息有誤,請檢查修改后重試 | 結果信息描述 |
違規(guī)記錄數(shù)據(jù) | violation_records | 否 | String(1024) | {"total_size":1,"violation_records":[{"company_name":"ABC公司","handle_method":"刷單欺詐,整改 限期 2天","handle_state":"超時未處理","illegal_type":"其他","punish_time":"2018-07-24 20:12:25","sub_mch_id":"1900012891"}]} | json格式。 total_size:記錄總數(shù) violation_records: company_name:公司名稱 handle_method:處理方式 handle_state:處理狀態(tài) punish_time:處罰時間 sub_mch_id:違規(guī)子商戶號 |
當violation_records_format為csv時響應包格式如下:
? 第一行展示總記錄數(shù),第二行開始展示每一條記錄。
? 每行記錄,csv格式顯示每列數(shù)據(jù),依次為“處罰時間”,“商戶號”, “公司名稱”, “處理方式”, “處理狀態(tài)”,“最后處理時間”(注意:這個字段只有在狀態(tài)為待處理時有返回)
? 每列記錄,以`開始,即標準鍵盤1左邊鍵的字符
Total: 30
`2017-06-27 19:06:41,`1373027702,`ABC公司,`刷單欺詐,整改 限期 2天,`已處理
`2017-06-25 16:43:01,`1373027702,`ABC公司,`其他,整改 限期 1天,已處理
`2017-06-27 19:06:41,`1373027702,`ABC公司,`刷單欺詐,整改 限期 2天,`已處理
`2017-06-25 19:06:41,`1373027702,`ABC公司,`誘導支付,整改 限期 2天,`超時未處理
`2017-06-25 19:06:41,`1373027702,`ABC公司,`跨類目(涉嫌資質),整改 限期 2天,`已處理
`2017-06-25 19:06:41,`1373027702,`ABC公司,`跨類目(涉嫌資質),整改 限期 2天,`已處理
`2017-06-25 19:06:41,`1373027702,`ABC公司,`跨類目(涉嫌資質),整改 限期 2天,`已處理
當violation_records為Json格式數(shù)據(jù)時,記錄內(nèi)容類似于:
{
"total_size" : 40,
"violation_records" : [
{
"punish_time":"2017-06-27 19:06:41",
"sub_mch_id": 1234,
"company_name": "ABC公司",
"illegal_type": "刷單欺詐",
"handle_method":"整改",
"handle_state":"已處理",
"deadline":"2017-07-27 23:59:59" //待處理狀態(tài)時才會有這個字段
},
{
"punish_time":"2017-06-27 20:16:01",
"sub_mch_id": 1234,
"company_name": "ABC公司",
"illegal_type": "其他",
"handle_method":"整改 限期2天",
"handle_state":"已處理" //無deadline字段
},
{...}, //后續(xù)數(shù)據(jù)類似,不再展開
{...},
{...},
... ...
]
}
錯誤列表:
錯誤碼 | 名稱 | 描述 | 解決方案 |
---|---|---|---|
SYSTEM_ERROR | 系統(tǒng)錯誤 | 微信支付內(nèi)部錯誤 | 重試或反饋 |
AUTH_ERROR | 權限錯誤 | 當前用戶無權訪問 | 開通權限后訪問 |
PARAM_ERROR | 參數(shù)錯誤 | 必需參數(shù)沒有填寫或非法 | 請對照上述參數(shù)列表填寫 |
SIGN_ERROR | 簽名錯誤 | 驗簽失敗 | 核對簽名 |
CERT_ERROR | 證書錯誤 | api證書驗證失敗 | 核對證書 |
INPUT_FORMAT_ERROR | 輸入數(shù)據(jù)格式錯誤 | xml格式非法 | 校驗xml格式 |