1. Business Accounts
Vrtx Docs
  • Welcome đź‘‹
  • Get Started
  • Auth
    • Token
      POST
  • Payouts
    • Create payout
      POST
    • Get payout status
      GET
    • Create bulk payout
      POST
    • Get bulk payout status
      GET
    • Get batch report
      GET
  • Transactions
    • Business Accounts
      • Get business account balance
        GET
      • Get transaction details by reference
        GET
      • List business transactions
        GET
  • Business Configurations
    • Get business configurations
      GET
  • Whitelist
    • Add whitelist entries
      POST
    • Get whitelist entries
      GET
    • Delete whitelist entries
      DELETE
Vrtx APIs
Vrtx Closed loop
Vrtx APIs
Vrtx Closed loop
  1. Business Accounts

Get business account balance

GET
https://api.sandbox.vrtx.sa/businesses/accounts/balance
Last modified:2026-05-31 10:00:08
Retrieves the current balance of the authenticated business's payout account.
The business is resolved from the JWT (businessId claim); no path parameters
are required.
Response:
Currency
Available balance
Error Scenarios:
401: Missing/invalid auth or business ID claim
404: Account not found for the authenticated business

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or

Responses

🟢200
application/json
Default Response
Bodyapplication/json

đźź 400
đźź 401
đźź 403
đźź 404
đźź 405
đźź 409
đźź 410
đźź 422
đźź 429
đź”´500
đź”´501
đź”´503
đź”´504
đź”´505
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.sandbox.vrtx.sa/businesses/accounts/balance' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "currency": "string",
    "balance": "string"
}
Modified at 2026-05-31 10:00:08
Previous
Get batch report
Next
Get transaction details by reference
Built with