BPN OpenAPI
  1. Account Management
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • KYB
      • Share KYB Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • add bank account
        POST
      • list bank account
        GET
      • create virtaul account
        POST
      • list virtual account
        GET
      • Master VA balance inquiry
        GET
      • list virtual account orders
        GET
      • refund virtual account order
        POST
    • Wallet
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • fx inquery
    • BPN Transactions
      • get stablecoin quote
      • create stable order
      • get order (single) detail
      • list orders(batch)
    • Reconciliation
  • Webhooks & Event
    • resend fail webhook
      POST
    • Open Virtual Account Status
      POST
    • virtual account payment status
      POST
    • Transaction Status Notification
      POST
    • KYB Status Notification
      POST
    • Deposit Sender Detail Required
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List
  • Release Notes & Changelog
    • Version History
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Account Management

Master VA balance inquiry

Developing
GET
/v1/virtual-account/primary/get-balance
This API allows you to check the total balance of your Master Virtual Account (VA) across different currencies.
It provides an aggregated view of available funds per currency, serving as a reference point for balance monitoring and as a prerequisite for initiating subsequent transfer transactions.

Request

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/virtual-account/primary/get-balance?currency='

Responses

🟢200Success
application/json
Body

Example
{
    "status": 0,
    "message": "string",
    "data": {
        "currency": "string",
        "balance": 0
    },
    "traceId": "string"
}
Previous
list virtual account
Next
list virtual account orders
Built with