在开始编码之前，需先了解接口调用时的一些注意事项：

1. 我司分配 appId、appSecret，并在发放请求的 notifyUrl 中提供回调地址。
2. 贵司提供测试、生产接口根地址 baseUrl，以及产品编码 productCode。
3. 请求方式：POST，Content-Type: application/json，字符编码 UTF-8。
4. 时间格式 yyyy-MM-dd HH:mm:ss，东八区。公共字段中的 timestamp 为 yyyyMMddHHmmss。
5. 每个请求和每次回调都带 appId、timestamp、sign，签名见【签名规则】。

对接前准备

1. 贵司实现发放、订单查询。发放不能当场给终态时，再实现下发结果通知。用户核销后实现核销通知。支持作废则额外实现作废接口，并在对接时告知我司。
2. 联调通过后，我司配置产品编码即可下发。

回调地址写在发放请求的 notifyUrl 里。请使用请求中的地址，不要写死环境。

环境	地址
测试	https://gw-test.senins.cn/depot-open/api/callback/standard
预发	https://gw-gray.senins.cn/depot-open/api/callback/standard
生产	https://gw.senins.cn/depot-open/api/callback/standard

接口根地址

我司调用贵司时使用贵司提供的 baseUrl，并自行拼接路径：

接口	路径
权益发放	POST {baseUrl}/equity/grant
权益作废	POST {baseUrl}/equity/void
订单查询	POST {baseUrl}/order/query

baseUrl 只写根地址，不要带上述路径。

通用约定

• HTTP 200 且 code 为 "0" 表示通讯成功。发放成败看 data.status。
• HTTP 非 200、超时、空响应：我司会按同一 orderId 重试。请保证幂等。
• code 不为 "0"：我司视为本次失败，不按网络异常重试。
• 我司调用贵司、贵司回调我司，使用同一套签名。

统一响应

{
  "code": "0",
  "message": "ok",
  "data": {}
}

code	含义
"0"	通讯成功
其他	参数或通讯错误，message 说明原因

回调我司时，我司同样返回这个结构。code 为 "0" 即可停止重试。

公共字段

每个请求和每次回调都带这三个字段。

参数名称	参数说明	是否必须	数据类型	说明
appId	应用标识	true	string	我司分配
timestamp	时间戳	true	string	yyyyMMddHHmmss，与接收方时间相差不超过 5 分钟
sign	签名	true	string	见 签名规则

订单状态

查询、下发通知、核销通知使用同一套取值。

status	含义
PROCESSING	处理中，尚未终态
SUCCESS	发放成功
FAIL	发放失败或作废失败
WRITE_OFF	已核销
VOID	已作废。未实现作废接口时不要返回此状态

已成功的订单再收到 SUCCESS、已核销的订单再收到 WRITE_OFF，我司按幂等处理。贵司仍应返回通讯成功。

权益数据

直充可以不传券码。有券码、卡密或链接时按下表填写 benefit。

参数名称	参数说明	是否必须	数据类型	说明
rechargeType	充值类型	true	string	0 直充，1 券码
cardType	卡券类型	券码类必填	int	0 券码，1 卡号卡密，2 链接
couponCode	券码	视类型	string	券码 / 卡号 / URL
cardPwd	卡密	卡密类必填	string	卡密
link	领取链接	false	string
batchNum	批次号	false	string