红包预下单接口

功能概述

用户使用账户余额或绑定银行卡向该商户下另一个钱包或多个钱包账户发等额或多个钱包账户发随机金额红包

接口地址

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

参数名称 参数中文名称 类型& 长度 参数说明 是否必填
merchantId 商户编号 varchar(9) 商户在首信易系统的唯一 id,可在商户后台查看 M
requestId 订单编号 varchar(50) 提交的订单号必须在账户交易中唯一;首信易数据支付系统中对于已创建的订单,商户端不能重复提交 M
walletId 钱包 ID varchar(19) 用户钱包在我司的唯一编号 M
currency 币种 varchar(15) CNY 人民币 M
packetType 红包类型 固定值 ONE_TO_ONE 一对一(最大金额为 200 元) M
GROUP_NORMAL 普通群红包(每个最大金额为 200 元)
GROUP_LUCK 拼手气红包(总金额=人数*200 元)
singleAmount 单笔金额 varchar(18) 以分为单位 C
amount 总金额 varchar(18) 以分为单位 拼手气红包必传此值 C
packetCount 红包数量 varchar(10) 一对一红包数量为 1,普通群红包和拼手气红包 数量最大 100 个 M
notifyUrl 通知地址 varchar(200) 订单终态后首信易支付会向该地址发送通知,该地址可以带参数,“https://www.5upay.com/callback.action?test=test 注意:如不填notifyUrl 的参数值您的服务器将得不到订单终态的通知。 O
timeout 订单超时时间 Int(4) 此参数用于设置订单的超时时间(只能设置 1-1440)。分钟为单位 O
remark 备注 varchar(300) 商户在首信易为订单进行备注,通过支付结果返回商户 O
hmac 参数签名 varchar(500) 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程 M

参数示例

{ "walletId":"33704400121811473", "amount":1, "serialNumber":"1218076634662449152", "merchantId":"890000595", "requestId":"202002251582614048062", "hmac":"IFfmOiAiJLgRZQLQTZ3yWtNYf/KHwfS2A2FkaBlvJ44tBNMGiihv+mBqAZ7PIvXK DJGbkwqS+AHhHpGutWQZso9twDbYAO0iTeztQjZLIZa6fTU228KvKTaYOX9pGD2+yS+I1D KjobIPWbJ+xFk2ARxgVC7QeqxsG4a/YNUC3lnAHkWIlgFg7DkIt9Eq2HQxWQml9M1QnbvN TwC5vtkfrX9cHR2/10FoSOgHwE+ivwQTb/Zxn9d+HYHcMtYZjig1ouLV8tTPgviovM9wgVv2 OadyxevFQnK5X1l5/QU0PKVk4aB38A1tsVctbUHMggtD4m2iAox9N4hpU7Iij7Zk9Q==", "orderStatus":"INIT", "currency":"CNY", "createDateTime":"2020-01-17 15:44:35", "status":"SUCCESS", "token":"20200117360666402850631691620352" }

同步返回参数列表

参数名称 参数中文名称 参数说明
status 响应状态 SUCCESS 响应正常
FAIL 响应异常
orderStatus 订单状态 INIT 初始化状态
CANCEL 取消
merchantId 商户编号 同请求参数
requestId 订单号 同请求参数
serialNumber 交易流水号 首信易支付系统交易流水号
currency 币种 CNY 人民币
walletId 钱包 ID 同请求参数
amount 红包金额 实际红包总金额
token 票据 通过此参数调起移动端 SDK(仅可使用一次)
remark 备注 在下单请求中提交的备注信息,返回给商户
createDateTime 创建时间 红包预下单,格式:yyyy-MM-dd HH:mm:ss
hmac 参数签名 商户生成的参数签名结果,获取hmac的方法请参考请求加密流程

参数示例

{ "status":"SUCCESS", "orderStatus":"INIT", "merchantId":"890000595", "requestId":"202002251582614048062", "serialNumber":"56d2649370d54d3eb0e2c64d7f1e5813", "walletId":"11111111", "amount":5, "token":"20191021030872371004968293048320", "createDateTime":"2019-10-21 18:41:17", "hmac":"oIwU783tfrm/upwfMffNESvvcbVxUTcUxkTVcgQmxb48ycVxXr4AxUIcLQpVSqE 8BZXlz90IiN72uup5134wZ988gmU6mDKybu42nMLE/+wa7/Ids8JNgebed7dJe2drq6dPIe IjOJxiBTwrL6Y8V6EYxIyA0oUCJftLMpDqODzcYC5/X/JjNc7SBGmqiZfcIXb9TK3RFVBz C7e6BHmODFJOTMZ/VxOkaAAPCW5GPoMq/zhU4V/Uk5a79dvMrIPZm6z8GiMdxbh6t pRT21Mq1ubbLHvg0VT5RHB4iYAiQ2ex3T7pnpOrxDWeiissZPj8kpVTcW8xJA2+99n+p0 b8eA==" }

异步返回参数列表

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

参数示例

{ "status":"SUCCESS", "orderStatus":"SUCCESS", "merchantId":"890000595", "requestId":"1571654460635", "serialNumber":"12345678", "receiveWalletId":"11111111" "currency":"CNY", "amount":"5", "paymentType":"BALANCE"' "createDateTime":"2019-10-21 18:41:17", "paymentTime":"2019-10-21 18:41:18", "completeDateTime":"2019-10-21 18:51:17", "hmac":"IpsfuWXscJCvcSCMtHbDZIqpFwG+TcvD3tLVbuZGflIbBv7DDigsYARc2h7b6oR Oec/9DKb41CqYWw2E7IegMj+OmDRUZOF6pXgNE8l7sAW+68UKJ4xKOFRCyqmw4H HZaxh7An5Ml/IYI1pfUYyAVSfaQGdnef4CTdkq+JJfBTjB2BED6CE0sCBEtWE7eT/bOYE +Ha1wlVhpbBxRG8/301QK5WtVh8l5whsdqDw+WqqEw5DMoxpBopZfrF8oxqNA/6/Fzb/ ZApUG4rwzRfFXBQaGQHZVe+JFTuOoXfDhPrdqT5Qhm6i2OZindeHx2Q0YoCxMNKu9f YIupX1Vw53Stg==" }