普通服务商查询扣费预约API

更新时间：2024.11.18

接口说明

商户调用「预约扣费」接口，因系统原因未能明确预约结果时，可使用本接口查询预结果。

接口说明

支持商户：【普通服务商】

请求方式：【GET】/v3/papay/pay/partner/schedules/contract-id/{contract_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。

query 查询参数

sub_mchid 　必填 string(32)

【子商户号商户号】微信支付分配的商户号

请求示例

GET

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/papay/pay/partner/schedules/contract-id/123124412412423431?sub_mchid=1900000109 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

应答参数

200 OK

schedule_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

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

属性

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日。

应答示例

200 OK

1{
2  "schedule_state" : "NO_SCHEDULED",
3  "deduct_start_date" : "2019-11-22",
4  "deduct_end_date" : "2019-11-22",
5  "scheduled_amount" : {
6    "total" : 1,
7    "currency" : "CNY"
8  },
9  "deduct_amount" : {
10    "total" : 1,
11    "currency" : "CNY"
12  },
13  "deduct_date" : "2019-11-22"
14}
15

错误码

公共错误码

状态码	错误码	描述	解决方案
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	接口返回错误	系统异常，请用相同参数重新调用

文档是否有帮助

更多支持

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