普通服务商受理扣款API

更新时间：2024.11.18

接口说明

商户调用「预约扣费」接口预约成功后，可调用本接口发起委托代扣扣款。系统受理扣款请求后，异步进行扣款，并通过商户指定的回调地址通知扣费结果。

规则说明

在可扣费期（调用「预约扣费」接口预约成功后返回）的可扣费期内，商户可调用本接口接口发起扣费，扣款金额等于<strong>预约扣费金额</strong>。扣费失败可再次调用本接口发起重试扣费（重试次数由其他规则限制），直到扣费成功或者可扣费期结束。

预约扣费金额：调用「预约扣费」接口时指定的金额。

扣费结果将通过「委托代扣支付结果通知API」通知，也可调用「查询订单」接口获取订单状态

接口说明

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

请求方式：【POST】/v3/papay/pay/partner/transactions/apply

请求域名：【主域名】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

body 包体参数

sp_appid 　必填 string(32)

【应用ID】商户在微信申请的公众号或移动应用AppID

sub_mchid 　必填 string(32)

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

sub_appid 　选填 string(32)

【子商户的AppID】AppID是商户在微信申请公众号或移动应用成功后分配的账号ID，登录平台为mp.weixin.qq.com或open.weixin.qq.com

out_trade_no 　必填 string(32)

【商户订单号】 商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一

description 　必填 string(127)

【商品描述】商品描述

transaction_notify_url 　必填 string(256)

【通知地址】异步接收微信支付结果通知的回调地址，通知URL必须为外网可访问的URL，不能携带参数。公网域名必须为HTTPS，如果是走专线接入，使用专线NAT IP或者私有回调域名可使用HTTP

contract_id 　必填 string(32)

【委托代扣协议ID】签约成功后，微信返回的委托代扣协议ID。

amount 　必填 object

【扣费金额信息】扣费金额信息，必须等于预约时传入的预约金额。

属性

total 　必填 integer

【金额】总金额，单位为分，只能为整数。

currency 　选填 string

【货币类型】枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY。

可选取值：

CNY: 预计扣费货币类型-人民币

goods_tag 　选填 string(32)

【订单优惠标记】订单优惠标记

attach 　选填 string(128)

【附加数据】附加数据，在查询API和支付通知中原样返回，可作为自定义参数使用

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/papay/pay/partner/transactions/apply \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "sp_appid" : "wxd678efh567hg6787",
8    "sub_mchid" : "1900000109",
9    "sub_appid" : "wxd678efh567hg6787",
10    "out_trade_no" : "1217752501201407033233368018",
11    "description" : "Image形象店-深圳腾大-QQ公仔",
12    "transaction_notify_url" : "https://www.qq.com/",
13    "contract_id" : "123124412412423431",
14    "amount" : {
15      "total" : 1,
16      "currency" : "CNY"
17    },
18    "goods_tag" : "DISCOUNTS",
19    "attach" : "自定义数据"
20  }'
21

应答参数

200 OK

out_trade_no 　必填 string(32)

【商户订单号】 商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一

amount 　必填 object

【扣费金额信息】实际进行的扣费信息

属性

total 　必填 integer

【金额】总金额，单位为分，只能为整数。

currency 　选填 string

【货币类型】枚举类型，符合ISO 4217标准的三位字母代码，默认为CNY，目前只支持CNY。

可选取值：

CNY: 预计扣费货币类型-人民币

应答示例

200 OK

1{
2  "out_trade_no" : "1217752501201407033233368018",
3  "amount" : {
4    "total" : 1,
5    "currency" : "CNY"
6  }
7}
8

错误码

公共错误码

状态码	错误码	描述	解决方案
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版)开发者社区微信开放平台微信公众平台腾讯客服