API 参考

介绍

本页介绍商户 API 响应和常见错误码。

统一响应结构

响应统一包含四个顶层字段：success、code、data 和 msg。

除认证失败返回 HTTP 401 之外，其他失败均返回 HTTP 200，响应结构内部标识失败。

典型成功响应：

{
  "success": true,
  "code": 0,
  "data": {
    "orderId": "ORDER_10001"
  },
  "msg": "ok"
}

典型业务失败响应：

{
  "success": false,
  "code": 2,
  "data": null,
  "msg": "parameter error"
}

典型认证失败响应：

HTTP/1.1 401 Unauthorized

{
  "success": false,
  "code": 14,
  "data": null,
  "msg": "signature is invalid"
}

code	name	default message	含义
0	`OK`	`ok`	请求成功。
1	`UNKNOWN_ERROR`	`unknown error`	未知内部错误。
2	`PARAMETER_ERROR`	`parameter error`	请求参数无效、缺失或不支持。
14	`TOKEN_INVALID`	`The token is invalid.`	API 认证失败（缺少头部、无效时间戳、无效签名、密钥过期、请求重放等签名问题）。
15	`MERCHANT_IS_BANNED`	`The merchant is banned.`	商户不可用。
18	`ORDER_PAY_EXPIRED`	`The order payment has expired.`	订单已过期。
19	`RATE_LIMITED`	`too many requests`	请求频率超限。
24	`MERCHANT_NOT_ACTIVE`	`merchant is not active, please recharge`	商户未激活，请充值手续费。