红包记录接口

功能概述

此接口专用于按月查询钱包账户的所有红包的成功交易的收发记录。

备注:在使用此接口前请使用红包记录统计接口查询判断所查月份是否有红包交易记录,有红包交易记录方可调用此接口查询该月数据。

接口地址

https://webox-api.5upay.com/webox/tradeRecord/redpacketBill

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一 id,可在商户后台查看 M
requestId 订单号 varchar(50) 包括红包,充值,转账订单号等,不是自定义号 O
walletId 钱包 ID varchar(19) 用户钱包在我司的唯一编号 M
pageIndex 当前页数 varchar(20) 当前页数,初始值为 1 M
pageSize 每页的条数 varchar(20) 如果为空 默认 20 条,最大 100 条 O
direction 资金方向 固定值 INCREASE 增加(入账) O
DECREASE 减少(出账)
如果不选,默认包括所有资金方向
tradeType 交易类型 固定值 WEBOX_REDPACKET 微包红包 O
WEBOX_REDPACKET_ONE_TO_ONE 一对一红包
WEBOX_REDPACKET_GROUP_NORMAL 普通群红包
WEBOX_REDPACKET_GROUP_LUCK 拼手气红包
WEBOX_REDPACKET_REFUND 红包退款
queryMonth 查询月份 varchar(20) 格式:yyyy-MM 例如:2020-05 M
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

参数示例

{ "direction": "DECREASE", "hmac": "rwKxuVg1qFrlNRE0aZA671wsmpTFV1Uye3jXLkxI5m8Kv4cUhIFzBJ/KP/iNQnI0CDSqZ9av/ qEdrf+0CW5eE5U2+YISUs3pT7biGBj+CqOuz6gnuLcWualUi5w6RZRgnuvjkYwCdIuL1Vq3eL r3wcLmS6PwyHMWBrwJZ91BVmbCUy0AjNtnvfYLmL6pxg34YpxZNqmBEzfm5kOXR8ami4 9vnfCt3X2BP646arodukJkTUa+u+BO9WK3F0t0FXxr/l+rnvIMpDWCd961Oeggl+YMDF5owZ 3Xg9LKygeIDeDCg5SCC/N5aYPqI81xqrcsX5Ax62dn2pUWzhNCMlrfbQ==", "merchantId": "896668917", "pageIndex": "1", "pageSize": "20", "queryMonth": "2020-06", "requestId": "1591070050577", "tradeType": "WEBOX_REDPACKET", "walletId": "10000000000012939" }

同步返回参数列表

参数名称 参数中文名称 参数说明
status 响应状态 SUCCESS 响应正常
FAIL 响应异常
direction 资金方向 同请求参数
tradeType 交易类型 同请求参数
merchantId 商户编号 同请求参数
requestId 订单号 同请求参数
walletId 钱包 ID 同请求参数
queryMonth 查询月份 同请求参数
total 查询当前结果条数 查询当前结果条数
pageSize 每页的条数 同请求参数
pageIndex 当前页数 同请求参数
records 记录列表 见下表(记录列表)
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

记录列表(records)

参数名称 参数中文名称 参数说明
direction 资金方向 INCREASE 增加(入账),包括充值,转账接收,转账拒收、转账超时、红包超时和红包领取。DECREASE 减少(出账),包括提现,转账和发红包。
tradeType 交易类型 WEBOX_REDPACKET 微包红包
WEBOX_ONE_TO_ONE 一对一红包
WEBOX_GROUP_NORMAL 普通群红包
WEBOX_GROUP_LUCK 拼手气红包
WEBOX_REDPACKET_REFUND 红包退款
tradeRecordId 交易记录 ID 交易记录唯一值,用于查看交易详情和删除
requestId 订单号 预下单订单号或抢红包订单号
serialNumber 交易流水号 预下单交易流水号或抢红包交易流水号
orderStatus 订单状态 SUCCESS 成功
SEND 已发送
TIMEOUT 超时退款
REJECT 拒收
currency 币种 预下单币种
amount 金额 预下单金额
redPacketCount 红包总个数 红包总个数
redPacketReceiveAmount 红包已领金额 红包已领金额
redPacketReceiveCount 红包已领个数 红包已领个数
createDateTime 创建时间 订单预下单的时间,或退款发起时间 格式:yyyy-MM-dd HH:mm:ss
completeDateTime 支付完成时间 订单支付完成的时间,或领取时间 格式:yyyy-MM-dd HH:mm:ss

参数示例

{ "direction": "DECREASE", "hmac": "YEuo9Wz+lJVitJeMjSMZU3bkOP2SwsJbQ61EQO++2UhMsOjUREuPo50F2iivys9Q+6V 0ZbQvCnziNv+C8JXdRaN+KQSp59flUlpK8uh70UGR9vki8SGw/KQxckew+6XeLNmK3e 3G0ryRZAMt/mujqmEDg+eAhymJTDUcRGVDSZyEoNUIGhuvpwefNsYJMSVI7+dk+y6C wAs+ATnVAmQH1oCe2sn3bD63FmWKR+KecG1sf8h/VniZaXptoHCZBWlbmJ16Hjqkres 8XEI8RAE9C73554aztPq9rW1JKA6ohG0AWV8eBFjkWb7fiwcF0hDgD/9kRMkverCXeY EvOOYkYA==", "merchantId": "896668917", "pageIndex": "1", "pageSize": "20", "queryMonth": "2020-06", "records": [{ "amount": 1300, "completeDateTime": "2020-06-02 11:54:22", "currency": "CNY", "direction": "DECREASE", "finalDateTime": "2020-06-02 11:55:06", "redPacketCount": "3", "redPacketReceiveAmount": 636, "redPacketReceiveCount": "1", "requestId": "1591070050577", "serialNumber": "1267665785615163392", "status": "TIMEOUT", "tradeRecordId": "126766578561516339210000000000012939DECREASE", "tradeType": "WEBOX_GROUP_LUCK" }], "requestId": "1591070050577", "status": "SUCCESS", "total": "1", "tradeType": "WEBOX_REDPACKET", "walletId": "10000000000012939" }