View Account Real-time Balance

General Account¶

Generally, you can use the following API to query the real-time balance of an account based on its transaction type and country.

If your account combines payin and payout functionalities (T+0 merchant), then you need to use the API for Merged Accounts to query the balance.

HTTP Request¶

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

GET /open-api/account/balance

RequestResponse

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,
        "availableBalance": 9999,
        "currency": "BRL"
    }
}

HTTP Headers Details¶

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

Request Params Details¶

Parameter	Required	Type	Description
countryCode		String	Country code, enumerate: BR,MX,US,CO,CL
transactionTypeCode		String	Transaction type code, enumerate: PAY_IN,PAY_OUT

Response Body Details¶

Parameter	Type	Description
code	Int	Response status code, such as 200
msg	String	Response status message, such as "success"
data	JSON	Response data

Object Parameters¶

Data¶

Parameter	Type	Description
accountBalance	Int	Account real-time balance (unit:cent)
availableBalance	Int	Account available balance (unit:cent)
currency	String	Balance currency, such as BRL, MXN

Merged Accounts¶

Only available for querying the real-time balance of accounts that have merged payin and payout functionalities (such as Mexican T+0 merchants). If the conditions are not met, an exception 'Feature is not supported' will be returned.