保险商户预约保险自动续费API
更新时间:2023.09.14# 接口说明
保险行业商户在进行委托代扣费前,需要提前在微信支付系统中预约保险自动续费,预约成功后方可在约定时间内扣费。
# 规则说明
- 保险自动续费规则:商户调用「受理保险自动续费扣款」接口进行委托代扣扣费前,需要指定保险扣费周期编号和扣费金额,扣费金额需要等于该周期指定的预计扣费金额,在保险扣费周期编号对应的可预约日的可预约时间段内调用「预约保险自动续费」接口,系统将会在调用成功后的30分钟内,为用户发送预扣费通知,并返回可扣费日期。该编号对应的保险扣费周期不能再次调用「预约保险自动续费」接口进行预约。调用「预约保险自动续费」接口成功后,商户可遵循下述扣费规则进行扣费。
- 扣费规则:在可扣费期的可扣费时间段内,商户可调用「受理保险自动续费扣款」接口发起扣费,扣费金额必须等于预约保险自动续费时传入的扣费金额。扣费失败可再次调用「受理保险自动续费扣款」接口发起重试扣费(重试次数由其他规则限制),直到扣费成功或者可扣费期段结束。
保险扣费周期:商户在跟用户签订委托代扣协议时指定的包含预计扣费日期和预计扣费最大金额的信息。具体见保险行业商户委托代扣预签约签约规则。
可预约日:商户在跟用户签订委托代扣协议时指定每个保险扣费周期中的预计扣费日期的前1个自然日当天至预计扣费日期后28个自然日当天,共30天。
可预约时间段:为了不打扰用户,商户只能在北京时间每天 [8:00,19:30)内调用「预约保险自动续费」接口。
可扣费期:商户预约成功后,预约接口返回的可扣费开始日期(即:预约成功日的后1个自然日)至可扣费结束日期(即:用户签约时指定的,每个保险扣费周期中的预计扣费日期的后29个自然日)之间为可扣费期。
可扣费时间段:为了不打扰用户,商户只能在北京时间每天 [8:00,20:00)内调用「受理保险自动续费扣款」接口。
预约保险自动续费示例 假设商户跟用户签约时指定了以下保险扣费周期
保险扣费周期编号 | 预计扣费时间 | 预计扣费金额 |
---|---|---|
1 | 2022-03-01 | 100元人民币 |
2 | 2022-04-01 | 100元人民币 |
3 | 2022-05-01 | 100元人民币 |
4 | 2022-06-01 | 100元人民币 |
第二个保险扣费周期的预约窗口期为2022-03-31至2022-04-29,商户可以在2022-03-31至2022-04-29之间的每日 [8:00,19:30) ,指定保险扣费周期编号为2、预计扣费金额100元人民币,调用「预约保险自动续费」接口,为第二个保险扣费周期进行预约,系统将会在调用成功后的30分钟内,为用户发送预扣费通知,并返回可扣费窗口期的开始日期(即:预约成功日的后1个自然日) 及结束日期(即:2022-04-30),商户可以在可扣费窗口期每天[8:00,20:00)内,调用「受理保险自动续费扣款」接口进行委托代扣扣费,直到扣费成功。扣费成功后,该保险扣费周期不能再次调用「预约保险自动续费」接口。商户可在第三个保险扣费周期的预约窗口期 2022-04-30至2022-05-29的每日 [8:00,19:30) ,为第三个保险扣费周期进行预约,但上次的预约会立即失效,不可再进行扣费,系统也不会下发扣费未完成通知。 若在2022-04-30 20:00前,仍未扣费成功,且未进行新一期的预约,系统将为用户下发扣费未完成通知,该保险扣费周期也不能再进行预约或扣费。
# 接口说明
# 请求参数
- Authorization 必填请参考 签名认证 生成认证信息
- Accept 必填请设置为
application/json
- Content-Type 必填请设置为
application/json
- policy_period_id 必填【保单的扣费周期编号】 进行预约的扣费周期编号,由商户在进行委托代扣签约时传入。需要大于0的正整数,且符合相关的业务规则。
- contract_id 必填【委托代扣协议ID】 签约成功后,微信返回的委托代扣协议ID。
- appid 必填【应用ID】 商户在微信申请的公众号或移动应用AppID
- scheduled_amount 必填【预约扣费金额信息】 预约扣费金额信息
- 属性
请求示例
# 应答参数
- policy_period_id 必填【保单的扣费周期编号】 保单的扣费周期编号,由商户在进行委托代扣签约时传入。需要大于0的正整数,且符合相关的业务规则。
- policy_period_state 必填【当前扣费周期的状态】 当前扣费周期的预约状态。
可选取值:NO_SCHEDULED
: 未进行预约SCHEDULED
: 已预约成功,未发起扣费或已发起扣费但扣费失败。PAID
: 已发起扣费且扣费成功EXPIRED
: 超过预计扣费时间且没有扣费成功。此时商户无法再进行预约或扣费。
- deduct_start_date 选填【可扣费开始日期】 可扣费的开始日期,当状态为已预约或已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。
- deduct_end_date 选填【可扣费结束日期】 可扣费结束日期,当状态为已预约或已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。
- scheduled_amount 选填【已预约的扣费金额信息】 已预约的扣费金额信息,当状态为已预约或已扣费时有返回。
- 属性
- deduct_amount 选填【实际扣费金额】 实际扣费金额,当预约状态为已扣费时有返回
- 属性
- deduct_date 选填【实际扣费的日期】 实际扣费的日期,当预约状态为已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。
应答示例
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
# 业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 无效请求 | 请根据接口返回的详细信息检查您的程序 |
403 | CONTRACT_NOT_EXIST | 签约协议不存在 | 请检查签约协议号是否正确,是否已解约 |
403 | NO_AUTH | 商户暂无权限使用此功能 | 请开通商户号权限。请联系产品或商务申请 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | SYSTEM_ERROR | 接口返回错误 | 系统异常,请用相同参数重新调用 |