Skip to content

View Real-time Balance

You can only request to view real-time balance in PROD environment. Requests to this endpoint wil not work in test environment.

HTTP Request


GET /open-api/account/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": {
        "accountBalance": 9999,
        "currency": "BRL"

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
transactionTypeCode String Transaction type code, enumerate: PAY_IN,PAY_OUT,MARKET_PLACE_ORDERS

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
accountBalance Int Account real-time balance (unit:cent)
currency String Balance currency, such as BRL, MXN
Back to top