通用约定

Base URL(示例)

https://api.baofu.com

实际前缀以环境配置为准;下列路径均为在网关之后的 相对路径

Header HTTP头参数
详细请参考【开发指引-整体说明

Header 必填 说明
Authorization 统一网关鉴权;签名算法与签名参数见下表(须在一行内,勿换行)
Content-Type 固定 application/json

宝付要求请求通过HTTP Authorization头来传递签名。Authorization由认证类型和签名信息两个部分组成。

Authorization: 认证类型 签名信息

具体组成为:

  • 认证类型,取值 RSA/SM2

签名信息

参数名 说明
mch_id 宝付分配的唯一商编
app_id 宝付终端号,选填,若传值,则使用宝付4.0证书
nonce_str 请求随机串,和上面构造签名串的随机串要保持一致
timestamp 时间戳 和上面构造签名串的时间戳要保持一致
serial_no 商户API证书序列号,用于声明所使用的证书
baofu_serial_no 宝付证书序列号, 联系技术支持提供
dgtl_envlp 数字信封(非必填),16位密钥,用宝付公钥加密后传输
signature 签名值,上面算出来的签名值

注意:以上七项签名信息,无顺序要求。数字信封参数可以为空

Authorization头的示例如下:(注意,示例因为排版可能存在换行,实际数据应在一行)

Authorization: RSA mch_id="128308",app_id="128308",nonce_str="P7X2R9Z1M5W6Q4V3B8C0D2E1F7G9H2J4",signature="DKLJASKLFGHQWJFPWQJLFKGDKSLGJPQJPFWQJLGKNDLSKJGLDSJLKFSJAKL",timestamp="1507488238",serial_no="123821002",baofu_serial_no="123822342",dgtl_envlp="GLKUIOWQGKDLSNGLKQWJPRQ"

Body 原则

  • 业务参数使用 驼峰 命名。
  • 统一会员标识、证书序列号、签名类型等已在网关 Header 中体现时,不要在 Body 重复传同名敏感元数据(与网关规范一致)。

统一响应

字段 类型 说明
success boolean true 表示业务成功(HTTP 一般为 200)
code string 失败时的错误码;成功时为 null
message string 失败时的提示文案
data object 成功时的业务载荷对象

成功示例:

{
  "success": true,
  "code": null,
  "message": null,
  "data": {
    "subscriptionNo": "SP01010120260319120000000001",
    "status": "ACTIVE"
  }
}

失败示例:

`json
{
“success”: false,
“code”: “INVALID_PARAMETER”,
“message”: “参数校验失败说明”,
“data”: null
}

###