Skip to content

调用说明

请求规范

请求发起要求

类型描述
传输方式采用HTTP/HTTPS传输
提交方式POST
参数类型application/json
响应类型application/json
字符编码UTF-8
签名算法MD5/HMAC_SHA256

参数规范注意事项

参数说明
交易金额单位为分,不能带小数。
时间参数所有涉及时间参数均使用精确到秒的13位时间戳

公共请求参数

字段名变量名必填类型示例值描述
用户IPclientIpString127.0.0.1支持V4和V6,部分支付方式要求必填,如调用微信支付方式时Long
随机数nonceStrString32d112892e382a7093
请求时间reqTimeLong123123121使用时间戳(秒级)
签名值signString072695d112892e382a7093b81e6a52af

公共响应参数

WARNING

状态码返回0只代表通信成功,业务是否成功需要看业务数据中的返回状态值,只有两者都为0,业务才算成功

名称字段类型示例值描述
状态码codeInteger ,0默认是0,非0表明请求失败,例如签名错误等
提示信息msgString
业务数据datajsonjson格式数据,不同的接口返回结构不同,可以参考业务公共响应参数
追踪IDtraceIdStringsIV4zJVhZ4Uz用于排查问题时

正常案例(业务成功)

json
{
    "msg": "success",
    "code": 0,
    "data": {
      "status": "pay_success",
      "code": 0,
      "resTime": 1715500234,
      "sign": "12221593a23d64246f5b8bc75c13a1ce581fb764934e9a8ef3294eddda5ec6a2"
    },
    "traceId": "VnmUJOT9yGGl"
}

业务失败

错误案例

json
{
  "msg": "未通过签名验证",
  "code": 20000,
  "traceId": "h12UXhTkPmt3"
}

业务公共响应参数

名称字段类型示例值描述
状态码codeInteger0为0表示成功,非0表示失败
错误信息msgString关闭失败状态非0时会有返回值
响应时间resTimeLong123123121服务返回请求的时间,时间戳(秒级)
响应数据签名值signString072695d112892e382a7093b81e6a52af对响应内容进行签名
本文档内容版权属于济南易杯光年软件技术有限公司