退款通知
业务场景
- 用户充值的订单，发生退款之后，将会推送退款信息
注意事项
- http请求失败会触发重试机制，可能会收到重复的退款通知，需要做好去重处理，避免重复执行退款逻辑
接口地址
地址由CP提供
接口说明
- 协议：HTTPS
- 方式：POST
- ContentType：application/json;charset=utf-8
- 请求 Header：
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| sdkApiVersion | int | 是 | 标识 SDK 的 API 版本号，目前使用新版 API 的数据格式和签名规则，值为：200 |
- 请求报文：
| 字段 | 类型 | 必需 | 参与签名 | 说明 |
|---|---|---|---|---|
| openId | string | 是 | 是 | SDK用户唯一标识 |
| serverId | string | 是 | 是 | 游戏区服ID |
| roleId | string | 是 | 是 | 游戏角色ID |
| sdkOrderNo | string | 是 | 是 | SDK订单号 |
| orderNo | string | 是 | 是 | CP订单号 |
| amount | long | 是 | 是 | 退款金额，单位分 |
| refundTime | string | 是 | 是 | 退款时间，格式：yyyy-MM-dd HH:mm:ss |
| timestamp | long | 是 | 是 | 毫秒时间戳，毫秒级 |
| extend | string | 是 | 否 | CP订单透传信息，不超过1000字符，不参与签名 |
| sdkExtend | object | 否 | 否 | 扩展信息，json字符串格式，不参与签名 |
| sign | string | 是 | 否 | 签名，参考签名规则 |
sdkExtend内容
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| cpGameArea | string | 否 | 游戏大区标识 |
| payTypeId | int | 否 | 支付方式id |
- 响应报文：
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
| code | int | 是 | 响应状态码 |
| msg | string | 否 | 响应描述 |
请求示例
{
"openId": "12345678912345678912345",
"serverId": "10158",
"sdkOrderNo": "2019010515034700909471",
"orderNo": "202151541584415",
"amount": 600,
"refundTime": "2022-06-01 10:20:45",
"timestamp": "1654142913840",
"extend": "{\"data\":\"17751|401203600007331|司徒宏放|45|3\"}",
"sign": "3ae039629da605edaec7ae38523ec877"
}
响应示例
{
"code": 0,
"msg": "success"
}
签名规则
- 参数名区分大小写，按 ASCII 码从小到大排序（字典序）
- 只有值为 null 和 参数名不参与签名 的键值对，才不参与签名
- 使用 URL 键值对的格式，拼接成待签名字符串，签名 key 在最后拼接，再进行MD5计算
- 将生成的签名与入参 sign 值作校验，验签忽略大小写
调试示例
import cn.hutool.crypto.SecureUtil;
import com.alibaba.nacos.shaded.com.google.common.collect.Maps;
import java.util.Map;
import java.util.TreeMap;
public class NotifyExample {
public static String getMd5Sign(Map<String, Object> params, String appKey) {
TreeMap<String, Object> sortedParams = new TreeMap(params);
StringBuilder builder = new StringBuilder(512);
sortedParams.forEach((k, v) -> {
if (v != null) {
builder.append(k).append("=").append(v).append("&");
}
});
builder.append("key=").append(appKey);
return SecureUtil.md5(builder.toString());
}
public static void main(String[] args) {
Map<String, Object> notifyMap = Maps.newLinkedHashMap();
notifyMap.put("openId", "12345678912345678912345");
notifyMap.put("serverId", "10158");
notifyMap.put("sdkOrderNo", "2019010515034700909471");
notifyMap.put("orderNo", "202151541584415");
notifyMap.put("amount", 600);
notifyMap.put("refundTime", "2022-06-01 10:20:45");
notifyMap.put("timestamp", 1654142913840L);
String appKey = "AaBbCcDdEeFfGgHh";
System.out.println(String.format("签名:%s", getMd5Sign(notifyMap, appKey)));
}
}
状态码
| 状态码 | 说明 |
|---|---|
| 0 | 成功 |
| 1000 | 未知错误 |
| 1001 | 验签失败 |
| 1002 | 参数缺失 |
| 1003 | 金额错误 |
| 1004 | openId错误 |
| 1005 | 游戏错误 |
| 1006 | 渠道错误 |
| 1007 | 订单不存在 |