保险商户查询保险扣费周期列表API

更新时间:2024.12.26

# 接口说明

商户可通过本接口查询已经签订的保险自动续费协议对应的扣费周期列表。

前置条件:用户签约成功,商户已经成功获取过保险自动续费协议。无法查询未签约成功的协议对应的扣费周期列表。

# 接口说明

支持商户:
【普通商户】
请求方式:
【GET】/v3/papay/insurance-sign/policy_periods/plan-id/{plan_id}/out-contract-code/{out_contract_code}
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • out_contract_code 必填 string(32)
    【商户签约协议号】 商户侧的签约协议号,商户侧需保证唯一性。
  • plan_id 必填 integer
    【委托代扣模板ID】 委托代扣模板ID,申请见接入指引中的接入流程相关内容。
    Query 查询参数
  • limit 选填 integer
    【分页大小】 设置该次请求返回的最大扣费周期条数,范围[1,120],默认值为20
  • offset 选填 integer
    【分页开始位置】 该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回。默认值为0

请求示例

GET

# 应答参数

    200OK
  • data 选填 array[object]
    【扣费周期列表,包括每个扣费周期项详情。】 扣费周期列表,包括每个扣费周期项详情。如果offset大于扣费周期总数,则会返回空数组。
    • 属性
  • limit 必填 integer
    【分页大小】 该次请求的最大资源条数(最后一页的数据数量小于等于该数字)。
  • offset 必填 integer
    【分页开始位置】 该次请求的分页开始位置,从0开始计数,例如offset=10,表示从第11条记录开始返回。
  • total_count 选填 integer
    【扣费周期总条数】 扣费周期总条数

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
400 INVALID_REQUEST 无效请求 请根据接口返回的详细信息检查您的程序
429 FREQUENCY_LIMITED 频率超限 请降低请求接口频率
500 SYSTEM_ERROR 接口返回错误 系统异常,请用相同参数重新调用
反馈
咨询
目录

您当前查看的是旧版文档,将于 2025年 3 月 31日 进行下线处理。为了获得最新的内容和产品能力,请点击 [这里] 访问新版文档中心