帮助中心

详情请参考 使用说明.接口规范

本项目以接口形式对外提供服务，主要的服务内容包括红包、储值的充值、扣减，对应单据的回调，详情查询等。

提供免登录后台的接口服务，API用户可根据自己业务系统的实际场景，调用我们对应的接口，可方便、快捷的完成各业务流程的打通交互。

通常对接流程大致步骤分为三步：
①. 登录我司后台，申请入驻API
申请入驻后，我司会及时对申请单据进行审核，审核通过后，可查看对应的appKey、appSecret、设置白名单、回调地址等操作
②. 接口对接，联调测试
根据自身业务需求及我司提供的对应接口、接口文档，将接口接入到自身业务系统，开发完毕后，上传至测试服，我司可配合联调测试
③. 灰度发布，测试，正式服正式部署发布

接口调用频次为300次/分钟，在满足业务需求的情况下，应尽量减少非必要的接口调用。

当接口返回数据异常是，请提供接口名称、请求及响应的报文信息，联系我司技术人员协助排查。

本系统总计有两类回调：
①. 红包回调
②. 储值回调
用户主动发起的充值、扣减等业务，可根据对应的业务类型，查看对应单据的实际处理状态；

TOKEN标识用户合法请求身份，有效期是永久有效，当用户 1.2 重置 TOKEN 后，上一个TOKEN时效，任意时刻，最多只存在一个有效TOKEN

登录管理后台，或者appKey、appSecret后，根据接口交互规范，请求 1.1 获取 TOKEN，TOKEN永久有效，可以适当做对应的缓存，以减少接口交互频次

请求红包充值、扣减接口时，传输的手机号为C端用户授权手机号，授权手机号标识唯一一个用户，当该手机号未授权时，无法正常处理红包的充值、扣减业务

同步返回失败的订单，表明该订单已处理完结，不会有对应的回调通知；同步返回成功的订单，仅表示系统接受请求数据成功，最终用户的余额变更，应以业务单据终态状态下的数据为准

手机号为用户的储值手机号，该手机号标识唯一一个用户；当手机号未被绑定为储值手机号时，系统以该手机号进行储值的充值或扣减，在用户绑定该储值手机号时，余额信息自动更新到用户余额中

同步返回失败的订单，表明该订单已处理完结，不会有对应的回调通知；同步返回成功的订单，仅表示系统接受请求数据成功，最终用户的余额变更，应以业务单据终态状态下的数据为准

现阶段回调通知主要有两类：
①. 用户调用我司红包、储值的充值和扣减接口时，我司会有处理结果的异步回调通知
②. C端会员在我司红包、储值余额有变动时，我司会触发对应的回调通知

根据现有两种类型的回调通知，用户可分别做对应的处理
①. 主动调用我司充值、扣减单据的，可调用对应的单据详情，查看对应单据的最终信息；
②. 用户余额变更类的，可根据回调内容的 trade_no, type 分别调用对应的余额变更详情接口，查看余额变更的实际信息

回调通知不保证一定送达，所以客户端应自行制定主动调用我司订单详情接口的策略，来获取最新单据的信息；回调通知最多通知五次，通知频次为 0s、30s、60s、180s、600s，五次通知失败后，不再进行通知

请求方式：POST, 请求及响应数据格式：JSON，字符编码：UTF-8

ContentType：application/json; charset=utf-8

回调通知格式：仅用户主动发起的充值、扣减时，orderNo,bizOrderNo 才会有值

{
        "result": "success", //string 处理结果：success 成功，failed 失败
        "notifyType": 1, // int 通知类型：1红包，2储值
        "tradeNo": 11637, // int 请求变更详情时的 flowId
        "orderNo": "24081615394989701933", // string 用户侧业务单号，请求充值，扣减时的单号
        "bizOrderNo": "24081009073551510366", // string 平台唯一业务单号
        "phone": "18688888888", // string 手机号
        "type": 1, // int 变更类型 1增加，2扣减
        "amount": 1, // int 变更金额，单位 分
        "chgTime": "1723797617", // string 变更时间戳
        "chgTimeCn": "2024年8月17日 10:23:56" // string 变更时间戳描述
}

响应格式:

{
        "status": 200, // int 必填, 状态码，非200时为失败
        "msg": "提示信息" // string 提示信息
}