Inquiry Master VA Balance

GET

/v1/virtual-account/primary/get-balance

Description
This API is used to query the available balance of the Master Virtual Account (Master VA) or main account for a specific fiat currency. It returns the real-time usable funds for the requested currency (ISO 4217), which can be used for balance monitoring, reconciliation, and as a prerequisite check before initiating subsequent transfers or payout transactions.

Query Parameter
Currency (string, required): Fiat currency code in ISO 4217 format (e.g., BRL, USD, EUR).

Use Cases

Check whether sufficient balance is available before sending a transfer/payout.

Monitor treasury balance by fiat currency.

Support reconciliation and operational troubleshooting.

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Examples

USDMXN

{
    "status": 200,
    "message": "success",
    "data": {
        "currency": "USD",
        "balance": 1999.00,
        "balanceString": "1999"
    },
    "traceId": "39d760f9a1814c4896a774bcf79da528"
}

Fiat Collection(BRL PIX for example)

Create Virtaul Account