偿还单列表查询
1.概述
通过【偿还单列表查询】接口,客户平台可以查询自己企业内的偿还单列表。
2.接口基本信息
| 信息名称 | 信息描述 |
| 请求方式 | POST |
| 调用地址 | 测试环境:waimai-openapi.apigw.test.meituan.com/api/sqt/open/repay/order/list/query 正式环境:bep-openapi.meituan.com/api/sqt/open/repay/order/list/query |
| 调用方 | 客户平台 |
| 响应方 | 美团企业版 |
| 响应超时时间 | 5s |
| 调用限频 | 每分钟访问不超过100次,每天累计访问不超过100,000次 |
2.1 请求体
| 名称 | 类型 | 是否必填 | 示例 | 说明 |
| accessKey | String | 是 | B3GFJIEHNEM1RLV-TK | 美团企业版分配给客户的接入秘钥 |
| content | String | 是 | UgxoCGPQIzoP | 请求体内容,将请求参数JSON序列化后进行加密的结果值,参照:签名实例 |
content 加密前数据结构
| 名称 | 类型 | 是否必填 | 示例 | 说明 |
| ts | Long | 是 | 1617085650321 | 13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟,平台将直接拒绝本次请求 |
| entId | Long | 是 | 46574 | 企业ID |
| pageNum | Integer | 否 | 1 | 当前页码:默认1,pageNum*pageSize<100000 |
| pageSize | Integer | 否 | 20 | 每页条数:默认20,最多支持1000 |
| minRepayTime | Long | 否 | 1569859200000 | 最小偿还支付时间,13位时间戳,需要与最大偿还支付时间结合使用,可以实现支付时间的区间查询 |
| maxRepayTime | Long | 否 | 1569869200000 | 最大偿还支付时间,13位时间戳,需要与最小偿还支付时间结合使用,可以实现支付时间的区间查询 |
2.2.响应参数
| 名称 | 类型 | 是否必填 | 示例 | 说明 |
| traceId | String | 是 | 56a0af18ae30a168d4006c7c | 日志查询ID,用于排查问题 |
| status | Integer | 是 | 0 | 接口响应编码,编码枚举值和解决方案详见第四章错误码 |
| msg | String | 否 | | 错误描述信息 |
| data | String | 是 | UgxoCGPQIzoP | 响应数据,将响应参数JSON序列化后进行加密的结果值,解密秘钥使用secretKey参数 |
data解密后数据结构
| 名称 | 类型 | 是否必填 | 示例 | 说明 |
| pageSize | Integer | 是 | | 每页条数 |
| pageNum | Integer | 是 | | 当前页数 |
| totalCount | Long | 是 | | 总条数,根据查询条件查询的结果集总数 |
| repayOrderList | List<RepayOrderListItem> | 是 | | 偿还单列表结果集 |
RepayOrderListItem字段说明
| 名称 | 类型 | 是否必填 | 示例 | 说明 |
| repayOrderId | Long | 是 | 393033370136698 | 偿还单号 |
| sqtBizOrderId | Long | 是 | 1658694873930 | 美团企业版订单号 |
| repayableAmount | String | 是 | "100.00" | 员工应偿还金额,单位元 |
| repayAmount | String | 是 | "100.00" | 员工已偿还金额,单位元 |
| refundAmount | String | 是 | "0.00" | 退款金额,单位元,当出现员工偿还金额过多时,会有客服退款,此字段为退款金额 |
| actualRepayAmount | String | 是 | "100.00" | 实际偿还金额,单位元,即员工已偿还金额 减去 退款金额 |
| repayReason | String | 否 | "超出预算" | 偿还原因 |
| repayOrderStatus | Integer | 是 | 10 | 偿还单状态枚举:10 待偿还,30 已偿还,40 无需偿还 |
| repayTime | Long | 否 | 393033370136698 | 偿还支付时间,13位时间戳,只有已偿还状态有值 |
3.请求示例
3.1 请求示例
content 明文
3.2 响应示例
data 明文
4.错误码
4.1.公共错误码
| 错误码 | 错误描述 | 解决方案 |
| 10010002 | 企业已停止合作,请联系客户经理进行确认 | 将接口调用的entId参数给到客户经理,由客户经理确认企业状态是否在合作中 |
| 10010003 | content不合法 | 详细阅读content参数加密说明(签名实例),确认content加密方式和content解密前传参是否正确 |
| 10010004 | ts缺失或ts时间已过期 | 确认ts是否传值并为13位时间戳,如果正确传值,则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟 |
| 10010005 | entId不能为空 | entId参数不可为空,如果未拿到entId参数,可以咨询客户经理获取 |
| 20010001 | accessKey不合法 | 检查accessKey是否为客户经理给到的值,如果accessKey值正确,确认调用环境是否和accessKey一致,如使用测试环境的accessKey调用线上的接口 |
| 20010002 | 请求path不合法 | 检查接口调用地址是否正确,如是否有非法字符 |
| 20010003 | 鉴权失败,无接口访问权限 | 将接口调用地址给到客户经理,由客户经理检查接口权限是否开通并保存成功 |
| 20010004 | 越权访问,无法访问该企业数据,请检查entId的正确性 | 检查accessKey和entId两个参数的对应关系是否正确 |
| 30010001 | 访问频率过高 | 请确认接口访问频率,每个接口默认调用限频为每分钟不超过100次,超出调用频率会调用此错误 |
| 30010002 | 访问次数超过配额 | 请确认接口的累计访问次数,每个接口的默认累计调用量为10w次,超出限额则会报错 |
4.2.业务错误码
| 错误码 | 错误描述 | 解决方案 |
| 10232000 | 参数异常 | 请根据msg中内容排查传值情况,确认必填字段是否传值,如minRepayTime大于maxRepayTime |
| 40232007 | 服务错误 | 请提供请求参数,联系客户经理进行排查。 |
5.版本记录
| 版本号 | 版本日期 | 更新内容 |
| V1.0 | 2023-12-20 | 初版 |