红包查询接口

功能概述

此接口的 SIMPLE 查询方式适用于查询该红包的支付信息(如:订单状态、红包金额等信息)。

此接口的 DETAIL 查询方式适用于红包支付成功 23 小时以后查询红包的领取信息(如:子红包领取人、领取金额、领取时间)。

备注:如果已获知订单已经为终态时,请保存。后续查询请查询本地数据,不要再次调用此接口。

接口地址

https://webox-api.5upay.com/webox/redpacket/query

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一 id,可在商户后台查看 M
requestId 订单号 varchar(50) 提交的订单号必须在账户交易中唯一;首信易数据支付系统中对于已创建的订单,商户端不能重复提交。 M
queryType 查询方式 固定值 SIMPLE 简单(用于查询红包发送信息) M
DETAIL 明细(仅用于查询 23 小时以后的红包领取信息)返回接收方信息,见下表(接收方信息)
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

参数示例

{ "merchantId": "890000595", "requestId": "202002251582614048062", " walletId ":"1233345", " queryType ":"SIMPLE", "hmac": null }

同步返回参数列表

参数名称 参数中文名称 参数说明
status 响应状态 SUCCESS 响应正常
FAIL 响应异常
orderStatus 订单状态 INIT 初始化状态
PROCESS 处理中
SEND 已发送
SUCCESS 成功
CANCEL 取消
TIMEOUT 订单超时(只有已经支付过的订单有此状态)
FAIL 失败
merchantId 商户编号 同请求参数
requestId 订单号 同请求参数
serialNumber 交易流水号 首信易支付系统交易流水号
walletId 钱包 ID 钱包 ID
receiveWalletId 接收钱包 ID 只有红包类型为 一对一 会返此参数
receivers 接收方信息 如果查询方式为详细 见下表(接收方信息),否则不返此参数
paymentType 支付方式 BALANCE 余额支付
BANK_CARD 银行卡支付
currency 币种 CNY 人民币
packetType 红包类型 ONE_TO_ONE 一对一
GROUP_NORMAL 普通群红包
GROUP_LUCK 拼手气红包
packetCount 发送总数量 发送总数量
singleAmount 发送单笔金额 只有红包类型为 一对一和普通群红包 会返此参数
amount 发送总金额 只有红包类型为 拼手气红包会返此参数
receivedAmount 已经接收总金额 已经接收总金额
receivedCount 已经接收总数量 已经接收总数量
refundAmount 退回金额 退回金额
bankCardNumber 卡号 掩码卡号,支付方式为银行卡时,返回此参数
bankCode 银行代码 支付方式为银行卡时,返回此参数
bankName 银行名称 支付方式为银行卡时,返回此参数
remark 备注 在下单请求中提交的备注信息,返回给商户
createDateTime 创建时间 预红包预下单时间 格式:yyyy-MM-dd HH:mm:ss
debitDateTime 支付完成时间 红包发送成功时间,格式:yyyy-MM-dd HH:mm:ss
completeDateTime 完成时间 红包最终领取完成或退回时间,格式:yyyy-MM-dd HH:mm:ss
orderErrorMessage 订单错误信息 只有订单状态出现异常时返回此参数
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

接收方信息

参数名称 参数中文名称 参数说明
requestId 抢红包订单号 抢红包订单号
serialNumber 抢红包交易流水号 抢红包交易流水号
receiveWalletId 接收钱包 ID 接收钱包 ID
amount 接收金额 单位为分
currency 币种 CNY 人民币
completeDateTime 红包领取时间 格式:yyyy-MM-dd HH:mm:ss
sel 红包顺序号 根据领红包的时间倒序排序,返回整数型 1,2,3 等

参数示例

{ "packetType":"ONE_TO_ONE", "walletId":"33704400121811473", "completeDateTime":"2019-11-05 11:02:26", "serialNumber":"20191105899703376322085708193792", "packetCount":"1", "singleAmount":"1", "orderStatus":"SUCCESS", "receivedAmount":"1", "createDateTime":"2019-11-05 10:49:37", "paymentType":"BALANCE", "merchantId":"890000595", "receivers":[{ "sel":"1", "amount":"1", "completeDateTime":"2019-11-05 11:02:25", "serialNumber":"2c95675f6e359b14016e397ae1c00017", "requestId":"202002251582614048062", "receiveWalletId":"33704400121811474", "currency":"CNY" }], "requestId":"202002251582614048062", "hmac":"zWl3O6YlP2DjxzTi7u1NOc/5peLraGfiBqAX/meSksZjMkoSNdoMgAoNU9X5r0rR2W ZCQ29Des07nMQYP9C0sys+JtxizCVAN+bDn1PLqEp2ivFoI6gNgCJMwLyqCd0rBUqRu6t/czK p9eUz/dAnhq7gC4fjkyRxgl5NHL4QMWJY1+hM2IgzLQ6QwiMoICZibFngvfndvUgRcCQ5jeW XsAi6/nnlEHMVX+j+otRv1VxZEoEVmO/OeF9B5EV9GPB56ZrRlonay0UkAGspBCJNpwJ4Q 9L8tEY4AyOEZ3vdRl4jy/f9Ui70vrhhA7dw7mJGGPGMf/KcEgz4rdlRZx+REQ==", "receiveWalletId":"33704400121811474", "currency":"CNY", "receivedCount":"1", "status":"SUCCESS" }