View Single Sub Merchant Balance

This API is used to query the balance of your sub merchant in a selected country.

Note

This API is available only when the sub merchant account is tracked independently. If the conditions are not met, an exception 'Feature is not supported' will be returned.

HTTP Request¶

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

GET /open-api/sub-merchant/balance

RequestResponse

Request Headers

{
    "Authorization": "Bearer {{access_token}}"
}

Request Example

curl "https://open.merchant.liquido.com/open-api/sub-merchant/balance?countryCode=BR&subMerchantId=234567"

Content-Type: application/json

{
    "code": 200,
    "msg": "success",
    "data": {
        "totalBalance": 9999,
        "availableBalance": 0,
        "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
subMerchantId		String	The ID of your sub merchant.

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
totalBalance	Int	The sub merchant balance (unit:cent)
availableBalance	Int	Withdrawable balance (unit:cent)
currency	String	Balance currency, such as BRL, MXN