基础支付
JSAPI支付
APP支付
H5支付
Native支付
小程序支付
合单支付
付款码支付
经营能力
微信支付分(公共API)
微信支付分(免确认预授权模式)
微信支付分(需确认模式)
支付即服务
行业方案
智慧商圈
微信支付分停车服务
电子发票
营销工具
代金券
商家券
委托营销
支付有礼
小程序发券插件
H5发券
图片上传(营销专用)
现金红包
资金应用
商家转账到零钱
分账
风险合规
消费者投诉2.0
其他能力
清关报关
图片上传
视频上传
微信支付平台证书

查询营销补差付款单列表API

最新更新时间:2021.04.13 版本说明


查询商家券营销补差付款单列表

接口说明

适用对象:直连商户

请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts

请求方式:GET


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
商家券批次号 stock_id string[1, 20] query由微信支付生成,调用创建商家券API成功时返回的唯一批次ID
示例值:128888000000001
商家券Code coupon_code string[1, 128] query券的唯一标识。
在WECHATPAY_MODE的券Code模式下,商家券Code是由微信支付生成的唯一ID;
在MERCHANT_UPLOAD、MERCHANT_API的券Code模式下,商家券Code是由商户上传或指定,在批次下保证唯一;
示例值:ABCD12345678
补差付款请求单号 out_subsidy_no string[1, 128] query商户调用补差付款API时填写的“业务请求唯一单号”
示例值:subsidy-abcd-12345678

请求示例


https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts?stock_id=128888000000001&coupon_code=ABCD12345678&out_subsidy_no=subsidy-abcd-12345678

{
JAVA示例代码
}

返回参数

参数名 变量 类型[长度限制] 必填 描述
+补差付款单据列表 pay_receipt_list array 如果这张券发生过补差付款,会有补差单据信息返回
参数名 变量 类型[长度限制] 必填 描述
补差付款单号 subsidy_receipt_id string[28, 32] 补差付款唯一单号,由微信支付生成,仅在补差付款成功后有返回
示例值:1120200119165100000000000001
商家券批次号 stock_id string[1, 20] 由微信支付生成,调用创建商家券API成功时返回的唯一批次ID
示例值:128888000000001
商家券Code coupon_code string[1, 128] 券的唯一标识
示例值:ABCD12345678
微信支付订单号 transaction_id string[28, 32] 微信支付下单支付成功返回的订单号
示例值:4200000913202101152566792388
营销补差扣款商户号 payer_merchant string[1, 32] 营销补差扣款商户号
示例值:1900000001
营销补差入账商户号 payee_merchant string[1, 32] 营销补差入账商户号
示例值:1900000002
补差付款金额 amount int 单位为分,单笔订单补差金额不得超过券的优惠金额,最高补差金额为5000元 > 券的优惠金额定义:
满减券:满减金额即为优惠金额
折扣券:优惠金额 = 微信支付订单金额 ÷ 折扣比例 × (1 - 折扣比例)
换购券:不支持
示例值:100
补差付款描述 description string[1, 1024] 付款备注描述,查询的时候原样带回
示例值:20210115DESCRIPTION
补差付款单据状态 status string[1, 32] 补差付款单据状态
ACCEPTED:受理成功
SUCCESS:补差补款成功
FAIL:补差付款失败
RETURNING:补差回退中
PARTIAL_RETURN:补差部分回退
FULL_RETURN:补差全额回退
示例值:SUCCESS
补差付款失败原因 fail_reason string[1, 1024] 仅在补差付款失败时,返回告知对应失败的原因
INSUFFICIENT_BALANCE:扣款商户余额不足
NOT_INCOMESPLIT_ORDER:非分账订单
EXCEED_SUBSIDY_AMOUNT_QUOTA:超出订单补差总额限制
EXCEED_SUBSIDY_COUNT_QUOTA:超出订单补差总数限制
OTHER:其他原因
示例值:INSUFFICIENT_BALANCE
补差付款完成时间 success_time string[28, 32] 仅在补差付款成功时,返回完成时间
示例值:2021-01-20T10:29:35.120+08:00
业务请求唯一单号 out_subsidy_no string[1, 128] 商户侧需保证唯一性。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号
示例值:subsidy-abcd-12345678
补差付款发起时间 create_time string[28, 32] 补差付款单据创建时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2021-01-20T10:29:35+08:00

返回示例


{
  "pay_receipt_list": [
    {
      "subsidy_receipt_id": "1120200119165100000000000001",
      "stock_id": "128888000000001",
      "coupon_code": "ABCD12345678",
      "transaction_id": "4200000913202101152566792388",
      "payer_merchant": "1900000001",
      "payee_merchant": "1900000002",
      "amount": 100,
      "description": "20210115DESCRIPTION",
      "status": "SUCCESS",
      "success_time": "2021-01-20T10:29:35.120+08:00",
      "out_subsidy_no": "subsidy-abcd-12345678",
      "create_time": "2021-01-20T10:29:35.120+08:00"
    }
  ]
}
                    

http://2323weixin.qq.com
                    

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 查看具体错误信息,调整参数
500 SYSTEM_ERROR 系统错误 多为网络超时引起,请使用相同参数稍后重新调用
401 SIGN_ERROR 签名验证失败 请检查签名参数和方法是否都符合签名算法要求
429 FREQUENCY_LIMITED 频率限制 调用太频繁,请降低调用接口频率
404 RESOURCE_NOT_EXISTS 券不存在 请检查批次id和券Code是否填写正确


技术咨询

文档反馈