查询红包记录 - Developer OpenAPI

注意事项：

查询红包记录API只支持查询30天内的红包订单，30天之前的红包订单请登录商户平台查询。

如果查询单号对应的数据不存在，那么数据不存在的原因可能是：（1）发放请求还在处理中；（2）红包发放处理失败导致红包订单没有落地。在上述情况下，商户首先需要检查该商户订单号是否确实是自己发起的，如果商户确认是自己发起的，则请商户不要直接当做红包发放失败处理，请商户隔几分钟再尝试查询，或者商户可以通过相同的商户订单号再次发起发放请求。如果商户误把还在发放中的订单直接当发放失败处理，商户应当自行承担因此产生的所有损失和责任。

XML具有可扩展性，因此返回参数可能会有新增，而且顺序可能不完全遵循此文档规范，如果在解析回包的时候发生错误，请商户务必不要换单重试，请商户联系客服确认红包发放情况。如果有新回包字段，会更新到此API文档中。

因为错误代码字段err_code的值后续可能会增加，所以商户如果遇到回包返回新的错误码，请商户务必不要换单重试，请商户联系客服确认红包发放情况。如果有新的错误码，会更新到此API文档中。

错误代码描述字段err_code_des只供人工定位问题时做参考，系统实现时请不要依赖这个字段来做自动化处理。

**请求地址：**https://api.mch.weixin.qq.com/mmpaymkttransfers/queryworkwxredpack
是否需要证书 : 是
**请求方式：**POST
**数据格式：**xml

文档ID: 11544
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/90276

请求参数

Body 参数application/xml

nonce_str

string

随机字符串

必需

sign

string

微信支付签名

必需

mch_billno

string

商户订单号

必需

mch_id

string

商户号

必需

appid

string

Appid

必需

示例

<xml>
    <nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
    <sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
    <mch_billno>123456</mch_billno>
    <mch_id>10000098</mch_id>
    <appid>wx8888888888888888</appid>
</xml>

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

return_code

string

返回状态码

必需

SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看result_code来判断

return_msg

string

可选

返回信息，如非空，为错误原因

sign

string

微信支付签名

必需

result_code

string

业务结果

必需

SUCCESS/FAIL

mch_billno

string

必需

商户订单号（每个订单号必须唯一）组成：mch_id+yyyymmdd+10位一天内不能重复的数字

mch_id

string

必需

微信支付分配的商户号

detail_id

string

必需

使用API发放现金红包时返回的红包单号

status

string

红包状态

必需

SENDING:发放 SENT:已发放待领取 FAILED：发放失败 RECEIVED:已领取 RFUND_ING:退款中 REFUND:已退款

wxappid

string

必需

商户appid，接口传入的所有appid应该为公众号的appid（在mp.weixin.qq.com申请的），不能为APP的appid（在open.weixin.qq.com申请的

re_openid

string

必需

接受收红包的用户在wxappid下的openid

total_amount

string

付款金额，单位分

必需

send_listid

string

红包订单的微信单号

必需

sender_name

string

必需

红包发送者名称(需要utf-8格式)

sender_header_media_id

string

必需

发送者头像素材id，通过企业微信开放上传素材接口获取

示例

<xml>
    <return_code><![CDATA[SUCCESS]]></return_code>
    <return_msg><![CDATA[ok]]></return_msg>
    <sign><![CDATA[C380BEC2BFD727A4B6845133519F3AD6]]></sign>
    <result_code><![CDATA[SUCCESS]]></result_code>
    <mch_billno><![CDATA[123456]]></mch_billno>
    <mch_id><![CDATA[10000098]]></mch_id>
    <detail_id><![CDATA[43235678654322356]]></detail_id>
    <status><![CDATA[RECEIVED]]></status>
    <send_type><![CDATA[API]]></send_type>
    <total_amount><![CDATA[5000]]></total_amount>
    <reason><![CDATA[余额不足]]></reason>
    <send_time><![CDATA[2017-07-20 22：45：12]]></send_time>
    <wishing><![CDATA[新年快乐]]></wishing>
    <remark><![CDATA[新年红包]]></remark>
    <act_name><![CDATA[新年红包]]></act_name>
    <openid><![CDATA[ohO4GtzOAAYMp2yapORH3dQB3W18]]></openid>
    <amount><![CDATA[100]]></amount>
    <rcv_time><![CDATA[2017-07-20 22：46：59]]></rcv_time>
    <sender_name><![CDATA[XX活动]]></sender_name>
    <sender_header_media_id><![CDATA[1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0]]></sender_header_media_id>
</xml>