Virtual Accounts

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, REFUNDED, KYT_PENDING, or KYT_REJECTED.
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):

{
  "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
}

GET

virtual-accounts

deposits

List deposits (all virtual accounts)

curl --request GET \
  --url https://api.balampay.com/v1/virtual-accounts/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.balampay.com/v1/virtual-accounts/deposits"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};

fetch('https://api.balampay.com/v1/virtual-accounts/deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.balampay.com/v1/virtual-accounts/deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/v1/virtual-accounts/deposits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/virtual-accounts/deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "deposits": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "currency": "<string>",
      "status": "PENDING",
      "created_at": "<string>",
      "updated_at": "<string>",
      "sender": {
        "name": "<string>",
        "account_number": "<string>",
        "address": "<string>"
      },
      "recipient": {
        "name": "<string>",
        "company_name": "<string>",
        "country": "<string>"
      },
      "payment_rail": "<string>",
      "settlement_tx_hash": "<string>",
      "source": {
        "name": "<string>",
        "account_number": "<string>",
        "address": "<string>",
        "payment_rail": "<string>",
        "reference_number": "<string>",
        "imad": "<string>",
        "omad": "<string>",
        "trace_number": "<string>"
      },
      "fees": {
        "base_fees": {
          "fixed_fee": "<string>",
          "percentage_fee": "<string>",
          "fx_markup": "<string>"
        },
        "client_markup": {
          "fixed_fee": "<string>",
          "percentage_fee": "<string>",
          "fx_markup": "<string>"
        },
        "total_fees": "<string>"
      },
      "net_amount": "<string>",
      "net_currency": "<string>",
      "metadata": {}
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123
}

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

Stable since 2025-01-01 — unchanged in 2026-04-14.

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

Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-04-14"

Query Parameters

page

integer

default:1

1-indexed page number.

Required range: x >= 1

limit

integer

default:10

Page size (1-100).

Required range: 1 <= x <= 100

status

enum<string>

Filter by deposit status.

Available options:

PENDING,

COMPLETED,

FAILED,

REFUNDED,

KYT_PENDING,

KYT_REJECTED

virtual_account_id

string<uuid>

Restrict the feed to one virtual account.

from_date

string

Inclusive lower bound on the deposit's received timestamp. ISO 8601 date-time or a date-only YYYY-MM-DD string.

to_date

string

Inclusive upper bound on the deposit's received timestamp. ISO 8601 date-time or a date-only YYYY-MM-DD string (date-only is treated as end-of-day).

Response

Success.

Page-based list envelope.

deposits

object[]

required

Show child attributes

total

integer

Total deposits matching the filters.

page

integer

limit

integer

total_pages

integer

List deposits (all virtual accounts)

curl --request GET \
  --url https://api.balampay.com/v1/virtual-accounts/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.balampay.com/v1/virtual-accounts/deposits"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};

fetch('https://api.balampay.com/v1/virtual-accounts/deposits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.balampay.com/v1/virtual-accounts/deposits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/v1/virtual-accounts/deposits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/virtual-accounts/deposits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "deposits": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "virtual_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "currency": "<string>",
      "status": "PENDING",
      "created_at": "<string>",
      "updated_at": "<string>",
      "sender": {
        "name": "<string>",
        "account_number": "<string>",
        "address": "<string>"
      },
      "recipient": {
        "name": "<string>",
        "company_name": "<string>",
        "country": "<string>"
      },
      "payment_rail": "<string>",
      "settlement_tx_hash": "<string>",
      "source": {
        "name": "<string>",
        "account_number": "<string>",
        "address": "<string>",
        "payment_rail": "<string>",
        "reference_number": "<string>",
        "imad": "<string>",
        "omad": "<string>",
        "trace_number": "<string>"
      },
      "fees": {
        "base_fees": {
          "fixed_fee": "<string>",
          "percentage_fee": "<string>",
          "fx_markup": "<string>"
        },
        "client_markup": {
          "fixed_fee": "<string>",
          "percentage_fee": "<string>",
          "fx_markup": "<string>"
        },
        "total_fees": "<string>"
      },
      "net_amount": "<string>",
      "net_currency": "<string>",
      "metadata": {}
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123
}

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

Authentication

Versioning

Users

Virtual Accounts

Quotations

Payouts

Recipients

Reference

List deposits (all virtual accounts)

Authorizations

Headers

Query Parameters

Response