跳转至

查看账户实时余额

一般账号

一般而言,通过下面接口,可以根据账号的业务类型和所属国家,查询到账号的实时余额。

如果您的账号合并了收款和汇款的业务(T+0商户),那么您需要使用合并账号的接口来查询余额。

HTTP 请求

BaseURL https://open.merchant.liquido.com

GET /open-api/account/balance

Request Headers
{ "Authorization": "Bearer {{access_token}}" }
Request Example
curl "https://open.merchant.liquido.com/open-api/account/balance?countryCode=BR&transactionTypeCode=PAY_IN"
Content-Type: application/json
{
    "code": 200,
    "msg": "success",
    "data": {
        "accountBalance": 9999,
        "currency": "BRL"
    }
}

HTTP Headers 字段说明

Key Value
Authorization "Bearer" + " " + {{access_token}}

请求参数

参数 必填 类型 描述
countryCode String 国家代码, 枚举: BR,MX
transactionTypeCode String 业务类型代码, 枚举: PAY_IN,PAY_OUT,MARKET_PLACE_ORDERS

响应字段说明

参数 类型 描述
code Int 状态码,如 200
msg String 状态信息,如 "success"
data JSON 返回数据

对象字段说明

Data

参数 类型 描述
accountBalance Int 账号的实时余额(单位:分)
currency String 货币种类, 如 BRL、 MXN

合并账号

仅用于查询合并了收款和汇款的账号(譬如墨西哥T+0的商户)的实时余额。不满足以上条件时,会出现:Feature is not supported的异常提示。

HTTP 请求

BaseURL https://open.merchant.liquido.com

GET /open-api/merchant/balance

Request Headers
{ "Authorization": "Bearer {{access_token}}" }
Request Example
curl "https://open.merchant.liquido.com/open-api/merchant/balance?countryCode=BR"
Content-Type: application/json
{
  "code": 200,
  "msg": "success",
  "data": {
    "totalBalance": 40651021,
    "availableBalance": 40651021,
    "currency": "BRL"
  }
}

HTTP Headers 字段说明

Key Value
Authorization "Bearer" + " " + {{access_token}}

请求参数

参数 必填 类型 描述
countryCode String 国家代码, 枚举: BR,MX

响应字段说明

参数 类型 描述
code Int 状态码,如 200
msg String 状态信息,如 "success"
data JSON 返回数据

对象字段说明

Data

参数 类型 描述
totalBalance Int 商户的实时余额(单位:分)
availableBalance Int 账户可用余额(单位:分)
currency String 货币种类, 如 BRL、 MXN
回到页面顶部