创建现金红包
| 应用场景
商户可以通过本接口,创建现金红包、并发红包给指定的用户。
| 接口调用规则
调用频率限制:50笔/秒;
单个红包金额限制:0.01元-200元;
| 接口说明
请求地址:
https://api.qpay.qq.com/cgi-bin/hongbao/qpay_hb_mch_send.cgi
| 数据格式:HTTP表单格式
| 请求方式:可采取GET、或POST方式
是否需要证书:验证双向数字证书| 请求参数
变量名 | 字段名 | 变量类型 | 必填 | 描述 | 示例值 |
charset | 字符集 | Int(1) | M | 输入字符编码: 1,UTF8 2,GBK 默认为UTF8 | 1 |
nonce_str | 随机串 | string(10-32) | M | 随机字符串 | 3e5a036cb4bc3a677a38ad9d69eb3feb |
sign | 签名 | string(32) | M | 业务参数签名(MD5)详见签名说明 | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
mch_billno | 商户订单号 | Long() | M | 商户订单号(每个订单号必须唯一); 组成:mch_id+yyyymmdd+10位一天内不能重复的的数字; 接口根据商户订单号支持重入,如出现超时可再调用。 | 1441246101201610101234567890 |
mch_id | 商户号 | string(12) | M | 商户的QQ钱包商户号 | 1441246101 |
mch_name | 商户名称 | string(4-64) | M | 商户名称,会展示在红包领取页面上 | 红包发送者名称 |
qqappid | appid | string(32) | O | 商户应用在腾讯体系的appid,可以在腾讯开放平台或者QQ互联申请; 当re_openid是openid时,qqappid必填 | 1007033799 |
re_openid | 接收者openid | string | M | 接收红包者openid或者uin,当re_openid是openid时,qqappid必填 | olSZRuGhmHFvtyB_eQtWEzcmGIX1 |
total_amount | 发放总金额 | long | M | 红包总金额(单位:分) | 100 |
total_num | 红包发放总人数 | int | M | 红包发放总人数(目前限制为1) | 1 |
wishing | 红包祝福语 | string(64) | M | 红包祝福语 | QQ钱包给您拜年啦! |
act_name | 活动名称 | string | M | 活动名称 | 春节发红包活动 |
icon_id | 商户logo图片ID | int | M | 在申请开通现金红包的流程中,商户提交logo图片给QQ钱包审核,审核通过后,QQ钱包返回该logo图片对应的icon_id给商户。 商户在接口中传入banner_id,则红包领取页的中间logo将会展示对应的图片。 此字段为必填项。 | 23 |
banner_id | 商户banner图片ID | int | O | 在申请开通现金红包的流程中,商户提交banner图片给QQ钱包审核,审核通过后,QQ钱包返回该图片对应的banner_id给商户。 商户在接口中传入banner_id,则红包领取页头部背景图将会展示对应的图片。 此字段选填,若不填,则展示官方默认背景图片。 | 24 |
notify_url | 红包领取结果通知 | String(256) | O | 接收QQ钱包异步通知回调地址,通知url必须为直接可访问的url,不能携带参数 。基于安全考虑,建议使用https。 | https://www.qpay.qq.com |
not_send_msg | 是否发送公众号消息链接 | int | O | 1、商户调用创建现金红包接口时,可以选择是否发送公众号消息链接,用户可以在公众号中点击消息链接拆红包。 2、not_send_msg为0,或者不传时,系统默认会发送红包公众号消息链接;当用户未关注该公众号或公众号消息发送失败时,创建红包接口会报错提示。(此时商户号的资金仍会扣除,用户是否领取红包,以领取通知接口返回为准,若未领取,红包金额会在24小时后退回商户号) 3、not_send_msg为1时,系统不会发送红包公众号消息链接 | 1 |
min_value | 最小红包金额 | long | M | 单个红包的最小金额(单位:分) | 1 |
max_value | 最大红包金额 | long | M | 单个红包的最大金额(单位:分) | 100 |
| 返回参数
变量名 | 字段名 | 变量类型 | 必填 | 描述 | 示例值 |
return_code | 返回状态码 | String(16) | M | SUCCESS/FAIL 此字段是通信标识,非交易标识 | SUCCESS |
return_msg | 返回信息 | String(128) | M | 返回信息,如非空,为错误原因 | 系统繁忙 |
retcode | 原始错误码 | String(16) | M | 原始错误码 | 10025 |
retmsg | 原始错误原因 | String(128) | M | 原始错误原因 | 系统繁忙 |
下列字段,在return_code为成功时有返回:
变量名 | 字段名 | 变量类型 | 必填 | 描述 | 示例值 |
listid | 红包单号 | String | M | 红包单号,成功时返回 | 101000000502201506300000100001 |
| 错误代码
错误码 | 描述 | 原因 | 解决方案 |
66228701 | 红包个数超出限制 |
|
|
66228705 | 总金额超出限制 | 单个红包的金额上限为200元,请检查total_amount字段是否超过200元 | 单个红包的金额上限为200元,请检查total_amount字段是否超过200元,该字段的值不能超过200元 |
66228706 | 总金额不足以按最小金额领取每个红包 |
|
|
66228707 | 商户签名校验失败 | 签名失败 | 请检查签名的方式是否正确 |
66228708 | 重入?? |
|
|
66228709 | openid转换uin失败 | 传入的appid和用户openid有误 | 请确认传入的openid是正确的 |
66228711 | 商户订单中的商户号有误 | 商户订单号商户号有误 | 请检查商户订单号中的商户号的格式和值是否正确 |
66228712 | 商户订单中的日期超过范围 | 商户订单号的日期有误 | 请在商户订单号中使用正确的日期 |
66228713 | 余额不足 | 商户号营销账户的资金余额小于红包金额 | 请检查商户号营销账户资金余额和发红包的金额 |
66228715 | 用户未关注公众号,发送AIO消息失败 | 用户没有关注QQ钱包的手Q公众号,发送QQ钱包公众号消息失败 | 引导用户关注QQ钱包公众号;如果不需要QQ钱包公众号消息,则可以在接口中选择不发送公众号消息: |
66229716 | 用户禁用公众号,发AIO消息失败
| 用户禁用了公众号,导致发送QQ钱包公众号消息失败 | 引导用户关注QQ钱包公众号;如果不需要QQ钱包公众号消息,则可以在接口中选择不发送公众号消息: |