余额查询接口

概述

余额查询接口允许商户实时查询账户余额信息。这对于资金管理、交易前余额检查以及财务对账都非常重要。

接口信息

• 接口地址：GET /api/balance
• 请求方式：GET
• Content-Type：application/json

请求头

所有 API 请求都需要在请求头中包含以下参数，详见 API签名规范：

参数名	类型	必选	说明
Content-Type	string	Y	application/json，固定值
MerchantId	string	Y	商户 ID，由 Veloraya 提供
Timestamp	string	Y	当前时间戳（毫秒），防止重放攻击
Nonce	string	Y	随机字符串，防重放攻击，每次请求唯一
Signature	string	Y	请求签名（RSA签名），Base64编码

请求参数

本接口无需请求参数，商户 ID 通过请求头传入。

响应格式

所有接口的响应都采用统一的 JSON 格式，包含以下字段：

参数名	类型	说明
code	int	响应码，200 表示成功，非 200 表示失败
msg	string	响应消息
data	object	响应数据，成功时包含余额信息

响应参数（data 字段）

参数名	类型	说明
availableBalance	BigDecimal	可用余额
unsettledAmount	BigDecimal	待结算余额
frozenAmount	BigDecimal	冻结余额

响应示例

查询成功

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "availableBalance": 16569.88,
    "unsettledAmount": 0.00,
    "frozenAmount": 131.61
  }
}

错误码说明

更多错误码详情请参见 错误码。

注意事项

• 请求头：必须在请求头中传入所有必需的参数（Content-Type、MerchantId、Timestamp、Nonce、Signature），详见 API签名规范。
• 签名验证：所有请求必须包含正确的签名。