Appearance
调用说明 ¶
请求规范 ¶
请求发起要求 ¶
类型 | 描述 |
---|---|
传输方式 | 采用HTTP /HTTPS 传输 |
提交方式 | POST |
参数类型 | application/json |
响应类型 | application/json |
字符编码 | UTF-8 |
签名算法 | MD5 /HMAC_SHA256 |
参数规范注意事项 ¶
参数 | 说明 |
---|---|
交易金额 | 单位为分,不能带小数。 |
时间参数 | 所有涉及时间参数均使用精确到秒的13位时间戳 |
公共请求参数 ¶
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
用户IP | clientIp | 否 | String | 127.0.0.1 | 支持V4和V6,部分支付方式要求必填,如调用微信支付方式时Long |
随机数值 | nonceStr | 否 | String | 32 | d112892e382a7093 |
请求时间 | reqTime | 是 | Long | 123123121 | 使用时间戳(秒级) |
签名值 | sign | 否 | String | 072695d112892e382a7093b81e6a52af |
公共响应参数 ¶
WARNING
状态码返回0只代表通信成功,业务是否成功需要看业务数据中的返回状态值,只有两者都为0,业务才算成功
名称 | 字段 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
状态码 | code | Integer , | 0 | 默认是0,非0表明请求失败,例如签名错误等 |
提示信息 | msg | String | ||
业务数据 | data | json | json格式数据,不同的接口返回结构不同,可以参考业务公共响应参数 | |
追踪ID | traceId | String | sIV4zJVhZ4Uz | 用于排查问题时 |
正常案例(业务成功) ¶
json
{
"msg": "success",
"code": 0,
"data": {
"status": "pay_success",
"code": 0,
"resTime": 1715500234,
"sign": "12221593a23d64246f5b8bc75c13a1ce581fb764934e9a8ef3294eddda5ec6a2"
},
"traceId": "VnmUJOT9yGGl"
}
业务失败 ¶
错误案例 ¶
json
{
"msg": "未通过签名验证",
"code": 20000,
"traceId": "h12UXhTkPmt3"
}
业务公共响应参数 ¶
名称 | 字段 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
状态码 | code | Integer | 0 | 为0表示成功,非0表示失败 |
错误信息 | msg | String | 关闭失败 | 状态非0时会有返回值 |
响应时间 | resTime | Long | 123123121 | 服务返回请求的时间,时间戳(秒级) |
响应数据签名值 | sign | String | 072695d112892e382a7093b81e6a52af | 对响应内容进行签名 |