保险商户查询保险自动续费预约API

更新时间:2023.09.14

# 接口说明

商户调用「预约保险自动续费」接口,因系统原因未能明确预约结果时,可使用本接口查询预结果。

# 接口说明

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

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • contract_id 必填 string(32)
    【委托代扣协议ID】 签约成功后,微信返回的委托代扣协议ID。
  • policy_period_id 必填 integer
    【保单的扣费周期编号】 需要查询预约状态的保单的扣费周期编号。由商户在进行委托代扣签约时传入。需要大于0的正整数,且符合相关的业务规则。

请求示例

GET

# 应答参数

    200OK
  • policy_period_id 必填 integer
    【保单的扣费周期编号】 保单的扣费周期编号,由商户在进行委托代扣签约时传入。需要大于0的正整数,且符合相关的业务规则。
  • policy_period_state 必填 string
    【当前扣费周期的状态】 当前扣费周期的预约状态。
    可选取值:
    • NO_SCHEDULED: 未进行预约
    • SCHEDULED: 已预约成功,未发起扣费或已发起扣费但扣费失败。
    • PAID: 已发起扣费且扣费成功
    • EXPIRED: 超过预计扣费时间且没有扣费成功。此时商户无法再进行预约或扣费。
  • deduct_start_date 选填 string(32)
    【可扣费开始日期】 可扣费的开始日期,当状态为已预约或已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。
  • deduct_end_date 选填 string(32)
    【可扣费结束日期】 可扣费结束日期,当状态为已预约或已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。
  • scheduled_amount 选填 object
    【已预约的扣费金额信息】 已预约的扣费金额信息,当状态为已预约或已扣费时有返回。
    • 属性
  • deduct_amount 选填 object
    【实际扣费金额】 实际扣费金额,当预约状态为已扣费时有返回
    • 属性
  • deduct_date 选填 string(32)
    【实际扣费的日期】 实际扣费的日期,当预约状态为已扣费时有返回。遵循rfc3339标准格式,格式为yyyy-MM-DD,yyyy-MM-DD表示年月日,例如:2015-05-20表示,北京时间2015年5月20日。

应答示例

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 接口返回错误 系统异常,请用相同参数重新调用
反馈
咨询
目录