Get virtual account balance - Kira API

GET

/

v1

/

virtual-accounts

/

{virtual_account_id}

/

balance

Get virtual account balance

curl --request GET \
  --url https://api.balampay.com/v1/virtual-accounts/{virtual_account_id}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Api-Version: <x-api-version>' \
  --header 'x-api-key: <api-key>'

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

Authorizations

Authorization

string

header

required

Access token from POST /auth (the data.access_token value).

x-api-key

string

header

required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version

string

required

Example:

"2026-04-14"

Path Parameters

virtual_account_id

string<uuid>

required

Virtual account UUID.

Response

Success.

List deposits (all virtual accounts)List inbound deposits across **all** of your virtual accounts (a client-level feed, no virtual-account id in the path), newest first. Supports pagination and filtering. **Query parameters** - `page` — 1-indexed page number. - `limit` — page size (`1`–`100`). - `status` — filter by `PENDING`, `COMPLETED`, `FAILED`, or `REFUNDED`. - `virtual_account_id` — restrict the feed to one virtual account. - `from_date` / `to_date` — inclusive bounds on the deposit's received timestamp. Accept an ISO 8601 date-time or a date-only `YYYY-MM-DD` string (a date-only `to_date` is treated as end-of-day). The response is an object with a `deposits[]` array plus page-based pagination (`total`, `page`, `limit`, `total_pages`). Each deposit has the same shape as `GET /v1/virtual-accounts/{virtual_account_id}/deposits`. All money values are decimal strings. **Example response (200):** ```json { "deposits": [ { "id": "7f1e9c2a-3b4d-4e5f-8a90-112233445566", "virtual_account_id": "550e8400-e29b-41d4-a716-446655440000", "amount": "1000.00", "currency": "USD", "status": "COMPLETED", "sender": { "name": "Acme Corp", "account_number": "****6789", "address": "123 Market St, San Francisco, CA" }, "recipient": { "name": "Jane Q Doe", "company_name": "Doe Holdings LLC", "country": "US" }, "payment_rail": "WIRE", "settlement_tx_hash": null, "source": { "name": "Acme Corp", "account_number": "****6789", "address": "123 Market St, San Francisco, CA", "payment_rail": "WIRE", "reference_number": "REF-998877", "imad": "20260625MMQFMP0100001", "omad": null, "trace_number": null }, "fees": { "base_fees": { "fixed_fee": "2.50", "percentage_fee": "0.00", "fx_markup": "0.00" }, "client_markup": { "fixed_fee": "1.00", "percentage_fee": "0.00", "fx_markup": "0.00" }, "total_fees": "3.50" }, "net_amount": "996.50", "net_currency": "USD", "created_at": "2026-06-24T18:05:32.000Z", "updated_at": "2026-06-24T18:07:10.000Z", "metadata": { "invoice_id": "INV-2026-0042" } } ], "total": 42, "page": 1, "limit": 10, "total_pages": 5 } ```

⌘I

Get virtual account balance

curl --request GET \
  --url https://api.balampay.com/v1/virtual-accounts/{virtual_account_id}/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Api-Version: <x-api-version>' \
  --header 'x-api-key: <api-key>'

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}