Balance & Transactions

GET

api

Account

{auth_id}

balance

{currency}

Get balance

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "currency": "INR",
  "balance": 23906.83,
  "reserved_funds": 0,
  "promotional_balance": 0,
  "promotional_reserved_balance": 0,
  "available_balance": 23906.83,
  "credit_limit": 1000,
  "is_postpaid": true,
  "credit_limit_type": "soft",
  "low_balance_threshold": 50,
  "status": "active",
  "created_at": "2026-01-19T18:39:15.050543Z",
  "updated_at": "2026-05-11T06:59:32.802705Z"
}

Get Transactions

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/transactions

Returns a list of transactions for a specific account.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Request

cURL

curl --location 'https://api.vobiz.ai/api/v1/Account/YOUR_AUTH_ID/transactions?limit=50&offset=0' \
--header 'X-Auth-ID: YOUR_AUTH_ID' \
--header 'X-Auth-Token: YOUR_AUTH_TOKEN' \
--header 'Accept: application/json'

Response

JSON Response

{
    "transactions": [
        {
            "id": "aabbccdd-1234-5678-90ab-cdef12345678",
            "account_id": "MA_XXXXXX",
            "balance_id": "11223344-5566-7788-99aa-bbccddeeff00",
            "type": "debit",
            "amount": 0.9,
            "currency": "INR",
            "description": "Stream session (70s)",
            "reference": "cdr:e565c2de-975c-4ba5-b115-44b1042cd397",
            "reference_type": "cdr",
            "status": "completed",
            "processed_at": "2025-12-08T09:38:06.923988Z",
            "created_at": "2025-12-08T09:38:06.923988Z",
            "updated_at": "2025-12-08T09:38:06.923988Z"
        }
    ],
    "summary": {
        "total_transactions": 125,
        "total_debit": 150.75,
        "total_credit": 500.00,
        "net_amount": 349.25,
        "by_reference_type": [
            {
                "reference_type": "cdr",
                "total_debit": 140.25,
                "total_credit": 0,
                "count": 110
            },
            {
                "reference_type": "did_rental",
                "total_debit": 10.50,
                "total_credit": 0,
                "count": 14
            },
            {
                "reference_type": "payment",
                "total_debit": 0,
                "total_credit": 500.00,
                "count": 1
            }
        ]
    },
    "total": 125,
    "page": 1,
    "per_page": 50,
    "total_pages": 3
}

Each transaction is keyed to the owning account by account_id. The reference_type groups spend by source - cdr (per-call charges), did_rental (phone-number setup and monthly fees), manual_adjustment, payment, and refund. DID purchases and recurring monthly number fees appear here as did_rental debits.

Query parameters

Field	Type	Required	Description
`limit`	integer	No	Maximum records to return. Default: 50. Maximum: 100.
`offset`	integer	No	Records to skip for pagination. Default: 0.

Get Balance

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}

Returns the balance for a specific account and currency.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your account Auth ID.
`currency`	string	Yes	Currency code to query (e.g., `INR`, `USD`). Must match a currency the account holds a balance in.

Response fields

Field	Type	Description
`balance`	number	Total ledger balance.
`reserved_funds`	number	Funds held against in-progress calls or pending charges.
`promotional_balance`	number	Non-withdrawable promotional credit.
`available_balance`	number	Spendable amount (`balance` minus reservations). Check this before purchasing a number.
`credit_limit`	number	Postpaid credit line.
`is_postpaid`	boolean	Whether the account bills postpaid.
`credit_limit_type`	string	`soft` or `hard`. A `hard` limit blocks new calls/purchases once exhausted.
`low_balance_threshold`	number	Threshold below which low-balance alerts fire.
`status`	string	Balance status (e.g., `active`).

Request

cURL

curl --location 'https://api.vobiz.ai/api/v1/Account/YOUR_AUTH_ID/balance/INR' \
--header 'X-Auth-ID: YOUR_AUTH_ID' \
--header 'X-Auth-Token: YOUR_AUTH_TOKEN' \
--header 'Accept: application/json'

Response

JSON Response

{
    "id": "aabbccdd-1234-5678-90ab-cdef12345678",
    "account_id": "MA_XXXXXXXX",
    "currency": "INR",
    "balance": 1000.00,
    "reserved_funds": 0,
    "promotional_balance": 0,
    "promotional_reserved_balance": 0,
    "available_balance": 1000.00,
    "credit_limit": 1000,
    "is_postpaid": true,
    "credit_limit_type": "soft",
    "low_balance_threshold": 50,
    "status": "active",
    "created_at": "2026-01-19T18:39:15.050543Z",
    "updated_at": "2026-05-11T06:59:32.802705Z"
}

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

currency

string

required

Currency code (e.g. INR, USD)

Example:

"INR"

Response

200 - application/json

Account balance

string

required

account_id

string

required

currency

string

required

balance

number

required

reserved_funds

integer

required

promotional_balance

integer

required

promotional_reserved_balance

integer

required

available_balance

number

required

credit_limit

integer

required

is_postpaid

boolean

required

credit_limit_type

string

required

low_balance_threshold

integer

required

status

string

required

created_at

string

required

updated_at

string

required

Get balance

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/balance/{currency}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "account_id": "MA_XXXXXXXX",
  "currency": "INR",
  "balance": 23906.83,
  "reserved_funds": 0,
  "promotional_balance": 0,
  "promotional_reserved_balance": 0,
  "available_balance": 23906.83,
  "credit_limit": 1000,
  "is_postpaid": true,
  "credit_limit_type": "soft",
  "low_balance_threshold": 50,
  "status": "active",
  "created_at": "2026-01-19T18:39:15.050543Z",
  "updated_at": "2026-05-11T06:59:32.802705Z"
}

​Get Transactions

​Request

​Response

​Query parameters

​Get Balance

​Path parameters

​Response fields

​Request

​Response

Authorizations

Path Parameters

Response

Get Transactions

Request

Response

Query parameters

Get Balance

Path parameters

Response fields

Request

Response