1.2.公共响应
本平台所有响应返回均采用JSON格式,body均采用UTF-8编码。
所有响应均按照以下通用格式定义:
参数 |
出现 |
类型 |
约束 |
描述 |
response |
1 |
String |
JSON格式的string字符串 |
标志本次业务返回结果体 |
response.head |
1 |
String |
JSON格式的string字符串 |
标志本次业务返回结果体头部数据 |
response.body |
1 |
String |
JSON格式的string字符串 |
标志本次业务返回结果体的业务返回对象 |
signature |
1 |
String |
签名,RSA加密 |
本次请求的返回体的加密签名,用于接口安全性校验。签名规则见本文档目录1.3.签名 |
字段名 |
字段含义 |
取值 |
备注 |
response.body.result_code |
通讯响应码 |
200,400,500 |
200:通讯成功,回调是否重试,根据这个状态判断;400:客户端错误;500:服务端错误 |
response.body.error_code |
通讯错误码 |
见通信错误码表 |
通讯 失败 的时候才返回 |
response.body.error_message |
通讯错误信息描述 |
见 通信错误码表 |
通讯 失败 的时候才返回 |
response.body.biz_response |
业务响应数据 |
JSON结构 |
通讯 成功 的时候才返回 |
response.body.biz_response.result_code |
业务执行响应码 |
见 业务响应定义 |
SUCCESS :业务处理成功
FAIL :业务处理失败 |
response.body.biz_response.error_code |
业务执行结果返回码 |
见 业务响应定义 |
业务处理失败时返回 |
response.body.biz_response.error_message |
业务执行错误信息 |
见 业务响应定义 |
业务处理失败时返回 |
response.body.biz_response.data |
业务执行返回参数 |
见各具体接口的返回参数定义 |
|
响应示例
{
"response": {
"head": {
"version": "1.0.0",
"appid": "28lp61847655",
"sign_type": "SHA256",
"response_time": "2001-07-04T12:08:56+05:30",
"reserve": "{}"
},
"body": {
"result_code": "200",
"biz_response": {
"result_code": "SUCCESS",
"data": {
"client_id": "cef236aa5d58416092199ac6dede29a2",
"client_merchant_sn": "73656906035",
"status": 1
}
}
}
},
"signature": "blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+uMh3GWbyzH02Y9dJQCW=="
}
通讯错误码:
序号 |
result_code |
error_code |
error_message |
说明 |
1 |
200 |
- |
- |
通讯成功 |
2 |
400 |
ILLEGAL_SIGN |
签名错误 |
请求签名不正确 |
3 |
400 |
ILLEGAL_APPLICATION |
非法应用 |
调用appid不存在 |
4 |
400 |
INVALID_PARAMS |
参数错误 |
参数不符合接口调用规则 |
5 |
500 |
UNKNOWN_ERROR |
系统错误 |
服务端出现未知错误 |
业务响应码:
序号 |
result_code |
error_code |
error_message |
说明 |
1 |
SUCCESS |
- |
- |
业务执行成功 |
2 |
FAIL |
实际业务错误码 |
业务执行失败原因 |
业务执行失败,失败原因:error_meesage |