保险商户修改保险扣费周期列表
更新时间:2025.01.06接口说明
商户可通过本接口修改已经签订的保险自动续费协议对应的扣费周期列表。
注意:当前仅支持减小状态为“NO_SCHEDULED”和“SCHEDULED”的扣费周期的预计扣费金额,暂不支持增加预计扣费金额 或 修改扣费周内的其他信息(包括总期数、每一期的扣费周期编号、预计扣费日期等)。即除了状态为“NO_SCHEDULED”和“SCHEDULED”的扣费周期传入新的预计扣费金额以外(注意一次请求内不允许有多个新的扣费金额),其余传入的扣费周期信息均需和签约时传入的保持一致。请求本接口前,请先通过查询保险扣费周期列表API确认计划修改金额的协议下所有扣费周期的最新状态。若请求本接口未获得明确结果时,也可通过查询保险扣费周期列表API确认修改的最终结果。
接口请求的前置条件:
用户签约成功,商户已经成功获取过保险自动续费协议
当前处于可修改时间段内(北京时间每天8:00至19:00 且 最后一期扣费预约日 19:00之前)
若修改涉及到“SCHEDULED”状态的扣费周期时,需确保当前处于该扣费周期的有效预约窗口期内,并且至少早于可预约结束日期的前一天(注意修改成功后,该扣费周期的状态将变更为“NO_SCHEDULED”,商户需按修改后的扣费金额通过保险商户预约保险自动续费API对该扣费周期重新发起预约)
接口请求的限次规则:
单份协议每天至多修改一次
单份协议永久至多修改三次
接口说明
支持商户:【普通商户】
请求方式:【POST】/v3/papay/insurance-sign/policy-periods/plan-id/{plan_id}/contract-id/{contract_id}/modify
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
path 路径参数
plan_id 必填 integer
【委托代扣模板ID】 委托代扣模板ID,申请见接入指引中的接入流程相关内容。
contract_id 必填 string(32)
【委托代扣协议ID】 签约成功后,微信返回的委托代扣协议ID
body 包体参数
appid 必填 string(32)
【应用id】 商户在微信申请的公众号或移动应用AppID
policy_periods 选填 array[PolicyPeriodBasicInfo]
【修改的扣费周期列表】 待修改的扣费周期列表,该扣费周期列表内除了状态为NO_SCHEDULED(未进行预约)和SCHEDULED(已预约)的扣费周期的预计扣费金额可以修改以外,其余信息包括扣费期数、每一期的扣费周期编号和预计扣费日期均需和签约时传入的扣费周期列表保持一致。另外需要注意,本接口目前仅支持减小预计扣费金额。
属性 | |
allow_cancel_scheduled 选填 boolean
【是否允许取消预约】 若需要为状态为SCHEDULED(已预约)的扣费周期修改预计扣费金额,则该字段需设置为true。该字段默认值为false。
请求示例
POST
应答参数
200 OK
policy_periods 选填 array[object]
【最新的扣费周期列表】 修改成功后的最新的扣费周期列表
属性 | |
cancel_scheduled_policy_period_id 选填 integer
【发生了取消预约的扣费计划项编号】 发生了取消预约的扣费计划项编号,0代表未发生取消预约
应答示例
200 OK
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 无效请求 | 请根据接口返回的详细信息检查您的程序 |
403 | NO_AUTH | 商户暂无权限使用此功能 | 请开通商户号权限。请联系产品或商务申请 |
429 | FREQUENCY_LIMITED | 频率超限 | 请降低请求接口频率 |
500 | SYSTEM_ERROR | 接口返回错误 | 系统异常,请用相同参数重新调用 |