Appearance
调用说明 ¶
请求规范 ¶
请求发起要求 ¶
类型 | 描述 |
---|---|
传输方式 | 采用HTTP /HTTPS 传输 |
提交方式 | POST |
参数类型 | application/json |
响应类型 | application/json |
字符编码 | UTF-8 |
签名算法 | MD5 /HMAC_SHA256 /SM3 |
参数规范注意事项 ¶
参数 | 说明 |
---|---|
交易金额 | 单位为元,保留两位小数。 |
时间参数 | 所有涉及时间参数均使用 yyyy-MM-dd HH:mm:ss 格式 |
公共请求参数 ¶
字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
---|---|---|---|---|---|
应用号 | appId | 否 | String | A5565221588 | 实际使用中请填写自己的appId, 应用号不可超过32位 |
客户端ip | clientIp | 否 | String | 127.0.0.1 | 支持V4和V6,部分支付方式要求必填,如调用微信支付方式时Long |
随机数值 | nonceStr | 否 | String | d112892e382a7093 | 生产随机数用于签名 |
请求时间 | reqTime | 是 | String | 2024-08-08 12:12:12 | 默认为当前时间,建议使用当前时间,与当前时间误差在5分钟以内 |
签名值 | sign | 否 | String | 072695d112892e382a7093b81e6a52af | 对数据进行签名的值 |
公共响应参数 ¶
WARNING
状态码返回0只代表受理业务成功,业务是否成功需要看具体业务的返回信息 不为0表示受理失败,具体响应吗可以参考返回状态码
名称 | 字段 | 类型 | 示例值 | 描述 |
---|---|---|---|---|
状态码 | code | Integer | 0 | 默认是0,非0表明请求失败,例如签名错误等 |
提示信息 | msg | String | 发生错误时会有数据返回 | |
业务数据 | data | Json字符串 | json格式数据,不同的接口返回结构不同,可以参考业务公共响应参数 | |
签名 | sign | String | sIV4zJVhZ4Uz | 返回数据的签名值 |
响应时间 | resTime | String | 2024-08-08 12:12:12 | 数据响应的时间, 如果时间与请求时间相差5分钟以上,请排查网络和安全问题 |
追踪ID | traceId | String | sIV4zJVhZ4Uz | 用于查询日志排查问题时进行快速定位 |
正常案例(业务成功) ¶
json
{
"msg": "success",
"code": 0,
"data": {
"status": "pay_success",
"code": 0,
"resTime": 1715500234
},
"sign": "12221593a23d64246f5b8bc75c13a1ce581fb764934e9a8ef3294eddda5ec6a2",
"resTime": "2024-08-08 12:12:12",
"traceId": "VnmUJOT9yGGl"
}
业务失败 ¶
错误案例 ¶
json
{
"msg": "未通过签名验证",
"code": 20000,
"sign": "12221593a23d64246f5b8bc75c13a1ce581fb764934e9a8ef3294eddda5ec6a2",
"resTime": "2024-08-08 12:12:12",
"traceId": "h12UXhTkPmt3"
}