统一约定
当前版本
当前版本是 1.0.0
数据响应格式
对于所有 API 的错误消息返回都是。且http状态是500
{
"code": 506800,
"message": "商户信息错误"
}
对于正常响应的数据。一般的如果是单条数据。格式如下
{
data:{....}
}
如果是多条数据。为了一眼区分,对应key是"list"。一般格式如下
{
list:[
{...},
]
}
默认message 返回的是英文信息。如果希望得到中文信息需要设置 header
"Accept-Language": "zh-CN"
如果想信息返回时英文。请设置 header(或不设置)
"Accept-Language": "en-US"
正常情况http状态是200.
- 本系统采用md5校验签名(签名细节见文档最后)。
- 数据响应/请求类型都是
application/json。 - 所有API请求方式都使用
POST - 字段名都是小写、下划线连接
- 货币单位都使用大写。
- 国家代码使用IOS2,2位小写(为了区分货币)
- 时间格式都使用
yyyy-MM-dd HH:mm:ss(默认 时区 UTC+8) - 金额单位保留两位小数。特别注意".00"会被省略。签名时候特被注意
- 由于系统有冷热数据区分,因此我放不会“严格限制商户单号在我方系统的唯一性”。对于重复单号,从严谨性上来说。也需要再个各自系统保证唯一
货币种类
| 代码 | 说明 | 对应国家、地区/市场 |
|---|---|---|
| USDT | 泰达币 Tether | 默认所有商户都有 |
| CNY | 人民币 | cn |
| PKR | 巴基斯坦卢比(Pakistan Rupee) | pk |
| BDT | 孟加拉塔卡(Bangladeshi Taka) | bd |
| IDR | 印度尼西亚卢比(Indonesia Rupiah) | id |
| PHP | 菲律宾比索(Philippine Peso) | ph |
错误代码
| 错误码 | 含义 |
|---|---|
| 506413 | 参数错误 |
| 506800 | 商户号错误 |
| 506801 | 商户密钥空 |
| 506802 | 签名错误 |
| 506803 | 渠道获取错误 |
| 506804 | 无渠道分配 |
| 506805 | 商户单号重复 |
| 506806 | 渠道获取失败 |
| 506807 | 渠道无效--直接是格式不对 |
| 506808 | 金额参数不对 |
| 506809 | 查询记录不存在 |
| 506810 | 无分组信息 |
| 506811 | CUR需要大写 |
| 506812 | 上游通道异常(临时维护等情况) |
| 506813 | 黑名单商户等情况,被后台清空了通道 |
| 506815 | 上游通道返回错误 |
| 506817 | 货币类型错误 |
| 506818 | 提交金额超限 |
| 506900 | 提交请求的API不在设置的IP白名单中 |