保险商户受理保险自动续费扣款API
更新时间:2023.09.14# 接口说明
商户调用「预约保险自动续费」接口预约成功后,可调用本接口发起委托代扣扣款。系统受理扣款请求后,异步进行扣款,并通过商户指定的回调地址通知扣费结果。
# 规则说明
在可扣费期(调用「预约保险自动续费」接口预约成功后返回)的可扣费时间段内,商户可调用本接口接口发起扣费,扣款金额等于预约扣费金额。扣费失败可再次调用本接口发起重试扣费(重试次数由其他规则限制),直到扣费成功或者可扣费时间段结束。
可扣费时间段:为了不打扰用户,商户只能在北京时间每天 [8:00,20:00)内调用「保险商户受理保险自动续费扣款」接口。
预约扣费金额:调用「预约保险自动续费」接口时指定的金额。
扣费结果将通过「委托代扣支付结果通知API」通知,也可调用「查询订单 (opens new window)」接口获取订单状态
# 接口说明
支持商户:
【普通商户】
请求方式:
【POST】/v3/papay/insurance-pay/transactions/apply
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看
# 请求参数
- Authorization 必填请参考 签名认证 生成认证信息
- Accept 必填请设置为
application/json
- Content-Type 必填请设置为
application/json
Header HTTP头参数
- appid 必填【应用ID】 商户在微信申请的公众号或移动应用AppID
- out_trade_no 必填【商户订单号】 商户系统内部订单号,只能是数字、大小写字母且在同一个商户号下唯一
- description 必填【商品描述】 商品描述
- transaction_notify_url 必填【通知地址】 异步接收微信支付结果通知的回调地址,通知URL必须为外网可访问的URL,不能携带参数。 公网域名必须为HTTPS,如果是走专线接入,使用专线NAT IP或者私有回调域名可使用HTTP
- contract_id 必填【委托代扣协议ID】 签约成功后,微信返回的委托代扣协议ID。
- policy_period_id 必填【保单的扣费周期编号】 进行保险自动续费的保险扣费周期编号,大于0的正整数,商户需要先对该保险扣费周期发起预约保险自动续费,并按业务规则发起保险自动续费。
- amount 必填【扣费金额信息】 扣费金额信息,必须等于预约时传入的预约金额。
- 属性
- goods_tag 选填【订单优惠标记】 订单优惠标记
- attach 选填【附加数据】 附加数据,在查询API和支付通知中原样返回,可作为自定义参数使用
Body 包体参数
请求示例
POST
# 应答参数
- out_trade_no 必填【商户订单号】 商户系统内部订单号,只能是数字、大小写字母且在同一个商户号下唯一
- amount 必填【扣费金额信息】 实际进行的扣费信息
- 属性
200OK
应答示例
200 OK
# 错误码
# 公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
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 | 接口返回错误 | 系统异常,请用相同参数重新调用 |
文档是否有帮助