外观
接口列表
约 1390 字大约 4 分钟
接口对接接口
2026-10-19
请按照 接入准备 中的约定实现接口,并参考 签名规则 对内容签名。
权益发放
接口地址: POST {baseUrl}/equity/grant
请求方式: POST
请求数据类型: application/json
接口描述: 我司下单时调用。必须实现。同一 orderId 重复调用只能对应一笔权益。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 说明 |
|---|---|---|---|---|
| orderId | 我司订单号 | true | string | 幂等键 |
| phone | 充值手机号 | true | string | |
| productCode | 产品编码 | true | string | 贵司产品编码 |
| notifyUrl | 回调地址 | true | string | 结果与核销回调地址 |
| appId | 应用标识 | true | string | 公共字段 |
| timestamp | 时间戳 | true | string | 公共字段 |
| sign | 签名 | true | string | 公共字段 |
响应参数:
| 参数名称 | 参数说明 | 类型 | 说明 |
|---|---|---|---|
| code | 状态码 | string | "0" 为通讯成功 |
| message | 描述 | string | |
| data | 发放结果 | object | |
| supplierOrderId | 贵司订单号 | string | 必须 |
| async | 是否异步 | boolean | false 表示本响应即终态;true 表示还要等下发结果通知 |
| status | 订单状态 | string | 同步成功 SUCCESS;同步失败 FAIL;异步受理 PROCESSING |
| message | 失败原因 | string | 失败时必须 |
| benefit | 权益数据 | object | 同步发券成功时必须 |
响应示例:
{
"code": "0",
"message": "ok",
"data": {
"supplierOrderId": "SP202610190001",
"async": false,
"status": "SUCCESS",
"benefit": {
"rechargeType": "1",
"cardType": 0,
"couponCode": "ABCD1234"
}
}
}异步受理:async 为 true,status 为 PROCESSING。终态改由 下发结果通知 给出。
明确失败:code 为 "0" 且 status 为 FAIL,或 code 不为 "0"。
下发结果通知
接口地址: 发放请求中的 notifyUrl
请求方式: POST
请求数据类型: application/json
接口描述: 供应商通知我司异步发放的终态。只有异步发放需要。同步成功不要再通知一次成功。
到达成功或失败后立即通知。失败至少重试 3 次(建议 1 分钟、5 分钟、30 分钟)。HTTP 200 且响应 code 为 "0" 即停止重试。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 说明 |
|---|---|---|---|---|
| orderId | 我司订单号 | true | string | |
| supplierOrderId | 贵司订单号 | true | string | |
| status | 订单状态 | true | string | SUCCESS 或 FAIL |
| message | 失败原因 | 失败必填 | string | |
| benefit | 权益数据 | 成功且有券码时必填 | object | |
| appId | 应用标识 | true | string | 公共字段 |
| timestamp | 时间戳 | true | string | 公共字段 |
| sign | 签名 | true | string | 公共字段 |
核销结果通知
接口地址: 发放请求中的 notifyUrl
请求方式: POST
请求数据类型: application/json
接口描述: 用户核销后通知我司。地址与下发通知相同,用 status 区分。有核销时必须实现。
重复核销通知请仍返回成功。我司不会覆盖已写入的核销时间。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 说明 |
|---|---|---|---|---|
| orderId | 我司订单号 | true | string | |
| supplierOrderId | 贵司订单号 | true | string | |
| status | 订单状态 | true | string | 固定 WRITE_OFF |
| writeOffTime | 核销时间 | true | string | yyyy-MM-dd HH:mm:ss |
| writeOffStore | 核销门店 | false | string | |
| benefit | 权益数据 | false | object | 可回带券码 |
| appId | 应用标识 | true | string | 公共字段 |
| timestamp | 时间戳 | true | string | 公共字段 |
| sign | 签名 | true | string | 公共字段 |
请求示例:
{
"appId": "APP_ID",
"timestamp": "20261019180000",
"sign": "...",
"orderId": "1987654321000000001",
"supplierOrderId": "SP202610190001",
"status": "WRITE_OFF",
"writeOffTime": "2026-10-19 17:30:00",
"writeOffStore": "杭州西湖店"
}权益作废
接口地址: POST {baseUrl}/equity/void
请求方式: POST
请求数据类型: application/json
接口描述: 我司作废已发放且未核销的权益。可选。不支持就不要提供,并在对接时说明。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 说明 |
|---|---|---|---|---|
| orderId | 我司订单号 | true | string | |
| supplierOrderId | 贵司订单号 | false | string | 有则传 |
| reason | 作废原因 | false | string | |
| appId | 应用标识 | true | string | 公共字段 |
| timestamp | 时间戳 | true | string | 公共字段 |
| sign | 签名 | true | string | 公共字段 |
响应参数: data.status 成功为 VOID。失败为 FAIL 并给 message。同一 orderId 重复作废返回 VOID。
订单查询
接口地址: POST {baseUrl}/order/query
请求方式: POST
请求数据类型: application/json
接口描述: 我司查询处理中的订单,以及已成功但未核销的订单。必须实现。返回状态与通知一致。单次最多 100 个 orderId。
请求参数:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 说明 |
|---|---|---|---|---|
| orderIds | 我司订单号 | true | string[] | 单次最多 100 个 |
| productCode | 产品编码 | false | string | 同一批属于同一产品 |
| appId | 应用标识 | true | string | 公共字段 |
| timestamp | 时间戳 | true | string | 公共字段 |
| sign | 签名 | true | string | 公共字段 |
响应参数:
| 参数名称 | 参数说明 | 类型 | 说明 |
|---|---|---|---|
| code | 状态码 | string | "0" 为通讯成功 |
| message | 描述 | string | |
| data | object | ||
| orders | 订单列表 | array | 查无此单的订单不要编成失败,直接不返回 |
| orderId | 我司订单号 | string | |
| supplierOrderId | 贵司订单号 | string | |
| status | 订单状态 | string | |
| message | 失败原因 | string | |
| benefit | 权益数据 | object | |
| writeOffTime | 核销时间 | string | |
| writeOffStore | 核销门店 | string |
响应示例:
{
"code": "0",
"message": "ok",
"data": {
"orders": [
{
"orderId": "1987654321000000001",
"supplierOrderId": "SP202610190001",
"status": "WRITE_OFF",
"writeOffTime": "2026-10-19 17:30:00",
"writeOffStore": "杭州西湖店"
}
]
}
}