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

更新时间：2024.09.02

接口说明

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

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

接口说明

支持商户：【普通商户】

请求方式：【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

请求示例

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/papay/insurance-sign/policy_periods/plan-id/12535/out-contract-code/wxwtdk20200910100000?limit=20&offset=10 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

data 　选填 array[object]

【扣费周期列表，包括每个扣费周期项详情。】扣费周期列表，包括每个扣费周期项详情。如果offset大于扣费周期总数，则会返回空数组。

属性

policy_period_id 　必填 integer

【保单的扣费周期编号】商户侧自定义的每个扣费周期的唯一ID，大于0的数字。

estimated_deduct_date 　必填 string(32)

【扣费周期预计的扣费的日期】扣费周期预计的日期，遵循rfc3339标准格式，格式为yyyy-MM-DD，yyyy-MM-DD表示年月日，例如：2015-05-20表示，北京时间2015年5月20日。

estimated_deduct_amount 　必填 object

【扣费周期预计的扣费金额】扣费周期预计的扣费金额。

属性

total 　必填 integer

【金额】总金额，单位为分，只能为整数。

currency 　选填 string

【货币类型】枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY。

可选取值：

CNY: 扣费货币类型-人民币

policy_period_state 　必填 string

【扣费周期预约状态】扣费周期预约状态

可选取值：

NO_SCHEDULED: 未进行预约

SCHEDULED: 已预约成功，未发起扣费或已发起扣费但扣费失败。

PAID: 已发起扣费且扣费成功

EXPIRED: 超过预计扣费时间且没有扣费成功。此时商户无法再进行预约或扣费。

scheduled_amount 　选填 object

【已预约的扣费金额信息】已预约的扣费金额信息，当状态为已预约或已扣费时有返回。

属性

total 　必填 integer

【金额】总金额，单位为分，只能为整数。

currency 　选填 string

【货币类型】枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY。

可选取值：

CNY: 扣费货币类型-人民币

deduct_amount 　选填 object

【实际扣费金额】实际扣费金额

属性

total 　必填 integer

【金额】总金额，单位为分，只能为整数。

currency 　选填 string

【货币类型】枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY。

可选取值：

CNY: 扣费货币类型-人民币

deduct_date 　选填 string(32)

【实际扣费的日期】预计扣费的日期，遵循rfc3339标准格式，格式为yyyy-MM-DD，yyyy-MM-DD表示年月日，例如：2015-05-20表示，北京时间2015年5月20日。

limit 　必填 integer

【分页大小】该次请求的最大资源条数（最后一页的数据数量小于等于该数字）。

offset 　必填 integer

【分页开始位置】该次请求的分页开始位置，从0开始计数，例如offset=10，表示从第11条记录开始返回。

total_count 　选填 integer

【扣费周期总条数】扣费周期总条数

应答示例

200 OK

1{
2  "data" : [
3    {
4      "policy_period_id" : 1,
5      "estimated_deduct_date" : "2019-11-22",
6      "estimated_deduct_amount" : {
7        "total" : 1,
8        "currency" : "CNY"
9      },
10      "policy_period_state" : "NO_SCHEDULED",
11      "scheduled_amount" : {
12        "total" : 1,
13        "currency" : "CNY"
14      },
15      "deduct_amount" : {
16        "total" : 1,
17        "currency" : "CNY"
18      },
19      "deduct_date" : "2019-11-22"
20    }
21  ],
22  "limit" : 20,
23  "offset" : 50,
24  "total_count" : 360
25}
26

错误码

公共错误码

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

业务错误码

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

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服