扣款结果通知
更新时间:2024.11.14该接口仅提供微信扣款服务申请扣款接口创建的订单进行扣款结果通知,支付完成后,微信会把相关支付结果及用户信息通过数据流的形式发送给商户,商户需要接收处理,并按文档规范返回应答。
|
接口说明
适用对象:服务商
请求URL:该链接是通过【申请扣款API】中提交的参数notify_url设置, 如果链接无法访问,商户将无法接收到微信通知。 通知url必须为直接可访问的url,不能携带参数。示例: “http://pay.weixin.qq.com/wxpay/pay.action”
通知规则
支付完成后,微信会把相关支付结果和订单信息发送给商户,商户需要接收处理该消息,并返回应答。
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为:0/15/15/30/180/1800/1800/1800/1800/3600(单位:秒) )
扣款成功通知参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string[1,16] | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 服务商申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 商户号是商户在微信申请微信支付成功后分配的账号ID,登录平台为pay.weixin.qq.com |
子商户应用ID | sub_appid | string[1,32] | 否 | 子商户号绑定的appid(非必填,如需操作,需要服务商在商户平台为子商户绑定) |
子商户号 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商户号。 |
设备号 | device_info | string[1,32] | 否 | 微信支付分配的终端设备号, |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位 |
签名 | sign | string[1,32] | 是 | 签名,详见签名算法 |
业务结果 | result_code | string[1,16] | 是 | SUCCESS/FAIL |
错误代码 | err_code | string[1,32] | 否 | 错误返回的信息描述 |
错误代码描述 | err_code_des | string[1,128] | 否 | 错误返回的信息描述 |
用户标识 | openid | string[1,128] | 是 | 用户在商户appid下的唯一标识 |
用户子标识 | sub_openid | string[1,32] | 否 | sub_appid下,用户的唯一标识 |
是否关注公众账号 | is_subscribe | string[1,1] | 否 | 用户是否关注公众账号,枚举值: |
付款银行 | bank_type | string[1,32] | 是 | 银行类型,采用字符串类型的银行标识,银行类型见银行列表 |
总金额 | total_fee | int | 是 | 订单总金额,单位为分,详见支付金额,(trade_state为SUCCESS和REFUND时才有返回) |
货币种类 | fee_type | string[1,8] | 否 | 货币类型,符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
现金支付金额 | cash_fee | int | 是 | 现金支付金额订单现金支付金额,单位为分,详见支付金额 |
现金支付货币类型 | cash_fee_type | string[1,16] | 否 | 货币类型,符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
交易状态 | trade_state | string[1,32] | 是 | SUCCESS:支付成功 |
代金券或立减优惠金额 | coupon_fee | int | 否 | 代金券或立减优惠金额<=订单总金额,订单总金额-代金券或立减优惠金额=现金支付金额,详见支付金额(预留功能,目前暂时没有返回此参数) |
代金券或立减优惠使用数量 | coupon_count | int | 否 | 代金券或立减优惠使用数量 (预留功能,目前暂时没有返回此参数) |
代金券或立减优惠ID | coupon_id_$n | string[1,20] | 否 | 代金券或立减优惠ID,$n为下标,从0开始编号 (预留功能,目前暂时没有返回此参数) |
单个代金券或立减优惠支付金额 | coupon_fee_$n | int | 否 | 单个代金券或立减优惠支付金额,$n为下标,从0开始编号 (预留功能,目前暂时没有返回此参数) |
微信支付订单号 | transaction_id | string[1,32] | 是 | 微信支付订单号 |
商户订单号 | out_trade_no | string[1,32] | 是 | 商户系统的订单号,与请求一致。 |
商家数据包 | attach | string[1,128] | 否 | 商家数据包,如果商户申请扣款有传,支付成功回调通知原样返回,支付失败回调通知暂不支持 |
支付完成时间 | time_end | string[1,14] | 是 | 支付完成时间,格式为yyyyMMddHHmmss,如2009年12月25日9点10分10秒表示为20091225091010。其他详见时间规则 |
委托代扣协议id | contract_id | string[1,32] | 是 | 签约成功后,微信返回的委托代扣协议id |
通知示例:
示例
扣款失败通知参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string[1,16] | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,为错误原因 |
以下字段在return_code为SUCCESS的时候有返回
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
应用ID | appid | string[1,32] | 是 | 服务商申请的公众号或移动应用appid。 |
商户号 | mch_id | string[1,32] | 是 | 商户号是商户在微信申请微信支付成功后分配的账号ID,登录平台为pay.weixin.qq.com |
子商户应用ID | sub_appid | string[1,32] | 否 | 子商户号绑定的appid(非必填,如需操作,需要服务商在商户平台为子商户绑定) |
子商户号 | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商户号 |
随机字符串 | nonce_str | string[1,32] | 是 | 随机字符串,不长于32位 |
签名 | sign | string[1,32] | 是 | 签名,详见签名算法 |
业务结果 | result_code | string[1,16] | 是 | SUCCESS/FAIL |
错误代码 | err_code | string[1,32] | 否 | 错误返回的信息描述 |
错误代码描述 | err_code_des | string[1,128] | 否 | 错误返回的信息描述 |
商户订单号 | out_trade_no | string[1,32] | 是 | 商户系统的订单号,与请求一致。 |
委托代扣协议id | contract_id | string[1,32] | 是 | 签约成功后,微信返回的委托代扣协议id |
通知示例:
示例
商户通知应答
如果商户侧未返回正确的内容,微信会多次通知,为了避免给商户服务器造成过大的压力,请在得到微信签约结果通知之后,返回以下内容。(请求方式:post)
注意:当商户后台应答失败时,微信支付将记录下应答的报文,建议商户按照以下格式返回。
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | return_code | string[1,16] | 是 | SUCCESS/FAIL |
返回信息 | return_msg | string[1,128] | 否 | 返回信息,如非空,为错误原因 |
返回示例:
示例
错误码
名称 | 描述 | 解决方案 |
---|---|---|
ACCOUNTERROR | 用户账户异常 | 请用户检查账户后再试 |
CONTRACT_NOT_EXIST | 协议不存在,用户已解约 | 建议重新签约 |
RULELIMIT | 用户账户支付已达上限 | 建议更换银行卡支付 |
BANKERROR | 支付银行卡所在行渠道维护中 | 建议更换银行卡支付 |
NOTENOUGH | 余额不足 | 建议更换银行卡支付 |
USER_ACCOUNT_ABNORMAL | 用户账户异常 | 请确认扣款用户的微信账号是否正常 |
USER_NOT_EXIST | 用户账户注销 | 请确认扣款用户的微信账号是否注销 |
TRADE_ERROR | 订单错误 | 请检查用户账号是否异常、被风控、是否符合规则限制等 |
USER_ERROR | 交易失败,该用户账号暂不可用 | 请用户检查账户后再试,如有疑问请联系微信客服检查账号状态 |