商家明细单号查询明细单
更新时间:2025.04.15普通直连商户可以通过该接口查询单笔品牌红包明细单。建议商户发放品牌红包后,间隔1分钟以上再调用该接口查单,避免查询失败
接口说明
支持商户:【普通商户】
请求方式:【GET】/v3/fund-app/brand-redpacket/brand-merchant-out-batches/{out_batch_no}/out-details/{out_detail_no}
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
path 路径参数
out_batch_no 必填 string(32)
【商家品牌红包批次单号】 商户系统内部的商家品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
out_detail_no 必填 string(32)
【商家品牌红包明细单号】 商户系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识,要求此参数只能由数字、大小写字母组成
请求示例
GET
应答参数
200 OK
brand_mchid 必填 string(32)
【品牌主商户号】 微信服务商下特约商户的商户号,且已经认证品牌的品牌主商户号
out_batch_no 必填 string(32)
【商家品牌红包批次单号】 商户系统内部的商家品牌红包批次单号,在商户系统内部唯一
batch_no 必填 string(64)
【微信支付品牌红包批次单号】 微信支付品牌红包批次单号,微信商家品牌红包系统返回的唯一标识
out_detail_no 必填 string(32)
【商家品牌红包明细单号】 品牌商户系统内部的品牌红包批次单号,要求此参数只能由数字、大小写字母组成,在商户系统内部唯一
detail_no 必填 string(64)
【微信支付品牌红包明细单号】 微信支付系统内部区分品牌红包批次单下不同品牌红包明细单的唯一标识
detail_state 必填 string
【品牌红包明细单状态】 品牌红包明细单状态
可选取值
DETAIL_INIT
: 系统转账校验中DETAIL_WAIT_PAY
: 待商户确认,符合免密条件时,系统会自动扭转为发送中DETAIL_PROCESSING
: 正在处理中,品牌红包发送结果尚未明确DETAIL_SUCCESS
: 发送成功DETAIL_FAIL
: 需要确认失败原因后,再决定是否重新对该笔品牌红包明细单进行发送(并非整个品牌红包批次单)
amount 必填 integer
【红包金额】 红包金额单位为“分”
remark 必填 string(32)
【红包备注】 单个品牌红包备注(微信用户会收到该备注),UTF8编码,最多允许32个字符
fail_reason 选填 string
【明细失败原因】 明细失败原因
可选取值
ACCOUNT_FROZEN
: 该用户账户被冻结REAL_NAME_CHECK_FAIL
: 收款人未实名认证,需要用户完成微信实名认证NAME_NOT_CORRECT
: 收款人姓名校验不通过,请核实信息OPENID_INVALID
: OpenID格式错误或者不属于商家公众账号TRANSFER_QUOTA_EXCEED
: 超过用户单笔收款区间,核实产品设置是否准确DAY_RECEIVED_QUOTA_EXCEED
: 超过用户单日收款额度,核实产品设置是否准确DAY_RECEIVED_COUNT_EXCEED
: 超过用户单日收款次数,核实产品设置是否准确PRODUCT_AUTH_CHECK_FAIL
: 未开通该权限或权限被冻结,请核实产品权限状态OVERDUE_CLOSE
: 该笔转账已关闭ACCOUNT_NOT_EXIST
: 该用户账户不存在TRANSFER_RISK
: 该笔转账可能存在风险,已被微信拦截USER_ACCOUNT_LIMIT
: 用户账户收款受限,请引导用户在微信支付查看详情FAIL_REASON_UNKNOWN
: 失败原因未知PAYER_ACCOUNT_ABNORMAL
: 商户账户付款受限,可前往商户平台获取解除功能限制指引PAYEE_ACCOUNT_ABNORMAL
: 用户账户收款异常,请联系用户完善其在微信支付的身份信息以继续收款USER_RECEIVE_OVERDUE
: 用户逾期未领取REMARK_NOT_CORRECT
: 红包备注设置失败,请修改后再试MERCHANT_REJECT
: 商户员工(转账验密人)已驳回转账MERCHANT_NOT_CONFIRM
: 商户员工(转账验密人)超时未验密BLOCK_B2C_USERLIMITAMOUNT_BSRULE_MONTH
: 超出用户单月转账收款20w限额,本月不支持继续向该用户付款
openid 必填 string(64)
【接收红包用户OpenID】 接收红包的用户OpenID,OpenID为用户在对应AppID下的唯一标识
user_name 选填 string(1024)
【接收红包用户姓名】 发放品牌红包时传入的接收红包用户姓名,已使用商户的公钥加密
initiate_time 选填 string(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年05月20日13点29分35秒
update_time 必填 string(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年05月20日13点29分35秒
brand_id 必填 integer
【品牌ID】 品牌在微信支付进行品牌认证后的唯一标识品牌ID
template_id 必填 string(128)
【品牌红包模板ID】 品牌主配置的品牌红包模板ID
brand_appid 选填 string(32)
【品牌AppID】 品牌商户在微信申请公众号/小程序或移动应用成功后分配的账号ID,该AppID需与品牌ID有绑定关系,具体请参考普通商户模式开发必要参数说明。
应答示例
200 OK
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
429 | FREQUENCY_LIMIT_EXCEED | 请求接口频率过快 | 降低频率,稍后重试 |
404 | NOT_FOUND | 记录不存在 | 确认订单号 |