BPN OpenAPI
  1. Wallet
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • Account Management
      • Inquiry Master VA Balance
      • Create Virtaul Account
      • Get Virtual Account Detail
      • List Virtual Account
      • Send Email Verify Code
      • Query bank info by account number
      • Payout via Virtual Account
      • Refund Virtual Account Order
      • Get Virtual Account Order Detail
      • List Virtual Account Orders
      • Submit Invoice
      • Get Invoice list Status
      • List Banks
      • Add Bank Account
      • List Bank Account
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
    • Wallet
      • List Wallets
        GET
      • List Sub Account
        GET
      • Create Sub Account
        POST
      • Wallet Internal Transfer
        POST
      • Get Asset Balance
        GET
      • Get Deposit Address
        GET
      • Add Deposit Sender
        POST
      • Add Withdraw Whitelist
        POST
      • Delete Withdraw Whiltelist
        POST
      • Request Withdraw
        POST
      • Query Transaction History
        GET
    • FX
      • Inquery FX Rate
    • BPN Transactions
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • Reconciliation
      • Get Reconciliation Order List By Page
    • Crypto Payment Link
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Mock
      • Mock Virtual account Payin Order
  • Webhooks & Events
    • Resend Fail Webhook
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Wallet

Get Asset Balance

GET
/v1/wallet/asset-balance
This endpoint allows you to query the wallet balances associated with your account. It supports two primary modes:
1.
All Balances Overview – Retrieves balances for all supported currencies in your wallet along with their total equivalent value in USD. The USD equivalent is calculated in real time using the latest market prices sourced from CoinMarketCap (CMC), providing an up-to-date estimate of your total asset value.
2.
Specific Currency Balance – Retrieves the balance for a specified currency only, along with its USD equivalent using the same real-time CMC pricing.
This API is useful for monitoring your asset holdings, tracking portfolio value across multiple currencies, and performing balance checks before initiating transfers or other 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/wallet/asset-balance?currency=USDC&walletId'

Responses

🟢200OK
application/json
Body

Example
{
    "status": 200,
    "msg": null,
    "code": null,
    "traceId": "83",
    "data": {
        "totalAvailable": 10,
        "totalAvailableCurrency": "USD",
        "id": 40,
        "walletType": "collection_sub",
        "name": "Michele Nader MD",
        "wallets": [
            {
                "currency": "USDT",
                "currencyFullName": "USD Tether",
                "available": 99,
                "unavailable": 9,
                "balanceChange": 64
            }
        ]
    }
}
Previous
Wallet Internal Transfer
Next
Get Deposit Address
Built with