查询投诉单列表API

最新更新时间:2020.11.27 版本说明


商户可通过调用此接口,查询指定时间段的所有用户投诉信息,并在返回结果分页输出查询结果。对于服务商、渠道商,可通过调用此接口,查询指定子商户号对应子商户的投诉信息,若不指定,则查询所有子商户投诉信。

接口说明

适用对象:直连商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/merchant-service/complaints

请求方式:GET

接口规则:https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
分页大小 limit int32 query该次请求每页返回的最大投诉条数,取值范围【1,50】,商户自定义字段,不传默认为10。
示例值:5
分页开始位置 offset int32 query该次请求的分页开始位置,商户自定义字段,默认为0,从0开始计数,譬如offset=10,表示从第11条记录开始返回。
示例值:10
开始日期 begin_date string[1,10] query投诉发生的开始日期,格式为YYYY-MM-DD。注意,查询日期跨度不超过30天。
示例值:2019-01-01
结束日期 end_date string[1,10] query投诉发生的结束日期,格式为YYYY-MM-DD。注意,查询日期跨度不超过30天。
示例值:2019-01-01
特约商户号 sub_mchid string[1,64] query被投诉子商户的商户号,当服务商或渠道商查询指定子商户的投诉信息时,传入此参数。
服务商模式,特约商户号必传
示例值:1900012181

请求示例


https://api.mch.weixin.qq.com/v3/merchant-service/complaints?offset=10&limit=20&begin_date=2019-01-01&end_date=2019-01-03
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述
+用户投诉信息详情 data array 用户投诉信息的详情。如果查询结果为空时,则为空数组。
参数名 变量 类型[长度限制] 必填 描述
商户订单号 out_trade_no string[1,64] 投诉对应的商户订单号。
示例值:20190906154617947762231
投诉时间 complaint_time string[1,32] 投诉时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
投诉金额 amount uint64 投诉金额,单位为分。
示例值:3
投诉人联系方式 payer_phone string[1,256] 投诉人联系方式,用户投诉时填写了手机号则返回,未填写则不返回。该字段已做加密处理,具体解密方法详见《敏感信息加密说明》。
示例值:Qe41VhP/sGdNeTHMQGlxCWiUyHu6XNO9GCYln2Luv4HhwJzZBfcL12sB+PgZcS5NhePBog30NgJ1xRaK+gbGDKwpg==
投诉描述 complaint_detail string[1,300] 投诉具体描述。
示例值:反馈一个重复扣费的问题
投诉单状态 complaint_state string[1,30] 已废弃,请使用“投诉单处理进展状态”
枚举值:
PAYER_COMPLAINTED:用户已投诉
FROZENED:交易已冻结
FROZEN_FINISHED:冻结已结束
PAYER_CANCELED:用户已撤诉
MERCHANT_REFUNDED:商户已退款
SYSTEM_REFUNDED:系统(微信支付)已退款
MANUAL_UNFROZEN:人工(微信支付运营人员)手动解冻
示例值:PAYER_COMPLAINTED
微信订单号 transaction_id string[1,64] 投诉对应的微信订单号
示例值:4200000404201909069117582536
冻结结束时间 frozen_end_time string[1,32] 若该投诉涉及资金冻结,则此字段表示冻结结束时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss.sss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒。
示例值:2015-05-20T13:29:35.120+08:00
特约商户号 sub_mchid string[1,64] 当服务商或渠道商查询时返回,返回具体被投诉子商户的商户号。
示例值:1900012181
投诉单处理进展状态 complaint_handle_state string[1, 64] 投诉单处理进展状态,标识当前投诉单所处的处理阶段,描述用户与商户的沟通反馈进度,将逐步取代投诉状态。具体状态如下所示:
WAIT_MERCHANT_RESPONSE:待商户处理
MERCHANT_RESPONSED:商户已反馈
USER_CONFIRMED:用户已确认
TIME_OUT_CLOSED:投诉超时关闭
MERCHANT_FULL_REFUNDED:商户全额退款
PAYER_CANCELED:用户已撤诉。
UNSPECIFIC:状态未知
示例值:WAIT_MERCHANT_RESPONSE
分页开始位置 offset uint32 该次请求的分页开始位置,从0开始计数,譬如offset=10,表示从第11条记录开始返回。
示例值:10
分页大小 limit uint32 该次请求返回的最大投诉条数,范围为【1,50】。
示例值:5
投诉总条数 total_count uint64 投诉总条数,投诉总条数,offset=0时返回,若记录不为空返回投诉总条数,若记录为空返回0。
示例值:1234

返回示例


> 200 Response
{
  "data": [
    {
      "out_trade_no": "20190906154617947762231",
      "complaint_time": "2015-05-20T13:29:35.120+08:00",
      "amount": 3,
      "payer_phone": "Qe41VhP/sGdNeTHMQGlxCWiUyHu6XNO9GCYln2Luv4HhwJzZBfcL12sB+PgZcS5NhePBog30NgJ1xRaK+gbGDKwpg==",
      "complaint_detail": "反馈一个重复扣费的问题",
      "transaction_id": "4200000404201909069117582536",
      "frozen_end_time": "2015-05-20T13:29:35.120+08:00",
      "sub_mchid": "1900012181",
      "complaint_handle_state": "WAIT_MERCHANT_RESPONSE"
    }
  ],
  "offset": 10,
  "limit": 5,
  "total_count": 1234
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
500 SYSTEM_ERROR 系统错误 5开头的状态码都为系统问题,请使用相同参数 稍后重新调用
400 PARAM_ERROR 参数错误 根据错误提示,传入正确参数
403 NO_AUTH 商户信息不合法 登录商户平台核对,传入正确信息
429 FREQUENCY_LIMITED 频率超限 请求量不要超过接口调用频率限制

版本说明

关闭
V1.1
2020年11月27日
1.接口名修改为查询投诉单列表
V1.0
2020年2月17日
1. 查询投诉信息接口上线

技术咨询

文档反馈