vrtx Docs
Core APIs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
SDK APIs
  • Coming Soon!
Core APIs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
SDK APIs
  • Coming Soon!
  1. Ledger
  • Card Transactions
    • Perform a simulated card transaction
      POST
    • Perform a balance inquiry
      POST
  • Notifications
    • Fetch the latest OTP for a mobile number
      POST
    • Fetch the latest notification message for a mobile number
      POST
  • Nafath
    • Trigger Nafath completion webhook
      POST
    • Preview Nafath completion webhook payload
      POST
  • Databases
    • Purge and seed all test databases
      POST
  • Topup
    • Run the payouts account topup job once
      POST
  • PTY Proxy
    • Proxy PTY API calls
      POST
  • Ledger
    • Perform a ledger transaction
      POST
    • Top up an account in the ledger
      POST
    • Get account balance
      GET
Core APIs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
SDK APIs
  • Coming Soon!
Core APIs
Core APIs
  • Start
  • Onboarding
  • Wallet
  • Payouts
  • Cards
  • Transactions
Closed loop APIsCard Simulator
SDK APIs
SDK APIs
  • Coming Soon!
  1. Ledger

Get account balance

GET
https://api.staging.vrtx.sa/testhelpers/ledger/accounts/{accountNumber}/balance
Last modified:2025-12-17 20:39:28
Retrieves the current balance for the specified account from the ledger. Returns balance in minor units and major units.

Request

Path 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 'https://api.staging.vrtx.sa/testhelpers/ledger/accounts//balance'

Responses

🟢200OK
application/json
Balance retrieved successfully
Body

Example
{
    "account_number": "users:001",
    "currency": "SAR",
    "amount": 10000,
    "amount_major": 100
}
🟠404Not Found
🔴500Internal Server Error
Modified at 2025-12-17 20:39:28
Previous
Top up an account in the ledger
Built with