所有接口默认返回 JSON 数据,返回非 JSON 格式的接口会在文档中做出说明。
注意:目前只要请求被服务端正常处理了,响应的 HTTP 状态码均为200。例如返回的消息体里的错误码是签名失败,但 HTTP 状态码是200,而不是401。
以创建预支付订单接口为例,若调用成功,其可能的返回如下:
{
"resultCode": 200,
"resultDesc": "成功",
"data": {
"tradeNo": "T16468087408287230",
"orderCode": "PO202403310001",
"redeemCode": "8A2B3C4D"
}
}
resultCode:API 处理结果代码,无论请求成功与否,只要 API 处理了,则必定会返回,此例中200代表处理成功。resultDesc:API 处理结果描述,无论请求成功与否,只要 API 处理了,则必定会返回。data:API 处理返回的详细数据信息,不同的接口所返回的字段参见接口文档中的定义。此例中tradeNo、orderCode和redeemCode均为创建预支付订单接口定义的字段,因为成功创建了预支付订单,所以返回了对应的交易流水号、预支付订单号以及相应的兑换码。若调用失败,其返回值示例如下:
{
"resultCode": 401,
"resultDesc": "失败,缺少Bearer Token",
"data": {}
}
resultCode:API 处理结果代码,无论请求成功与否,只要 API 处理了,则必定会返回,此例中401代表处理失败。resultDesc:API 处理结果描述,无论请求成功与否,只要 API 处理了,则必定会返回。data:API 处理返回的详细数据信息。此例中由于 API 处理失败,所以返回空。返回结果中如果resultCode非200,则表示调用 API 接口处理失败。 resultCode 字段表示错误码,resultDesc 字段表示具体的错误信息,所有业务都可能出现的错误码为公共错误码。公共错误码如下:
| 错误码 | 错误描述 |
|---|---|
| 200 | 处理成功 |
| 401 | 用户身份验证失败 可能包含的错误:缺少Bearer Token/Token解析异常/JWT Claim缺失/aud不匹配/Token已过期/iat非法/疑似重放请求/未找到匹配算法的可用公钥/JWT验签失败 |
| 500 | API 处理失败,服务器内部错误 |
| 91001 | 参数不能为空 |
| 91002 | 请求体不能为空 |
| 91009 | 分销账户不存在或已停用 |