Skip to content

View Real-time Balance

HTTP Request


GET /open-api/account/merchant/balance

Request Headers
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}"
Request Example
   Request Method: GET 
Content-Type: application/json
    "code": 200,
    "msg": "success",
    "data": {
        "totalBalance" : "9999",
        "withdrawableAmount" : "9999",
        "currency" : "USD"

HTTP Headers Details

Key Value
Content-Type application/json
Authorization "Bearer" + " " + {{access_token}}

Request Params Details

Parameter Required Type Description
countryCode String Country code, enumerate: BR,MX,US,CO,CL

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


Parameter Type Description
totalBalance Int Account real-time balance (unit:cent)
withdrawableAmount Int PAY-IN withdrawable balance + PAY-OUT account balance (unit:cent)
currency String Balance currency, such as BRL, MXN
Back to top