Virtual Accounts

List virtual accounts

Use limit<=100 — limit above 100 returns a clean 400 validation error (same cap as GET /v1/users; applies to ALL list endpoints). There is no top-level provider or currency on a virtual account — the rail is exposed as bank, and a crypto VA’s currency is under destination.currency (identical in list and get-by-id views).

Status filter vs. response status: the status query filter uses the raw lifecycle values (pending, activating, active, failed, deactivated), while the status on each returned account is the KYB-mapped value (approved, rfi, declined, deactivated). Filter on raw; read the mapped value off the response.

GET

virtual-accounts

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

import requests

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

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', 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",
  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"

	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")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "approved",
      "type": "US_BANK",
      "mode": "fiat",
      "created_at": "<string>",
      "updated_at": "<string>",
      "bank": "<string>",
      "destination": {},
      "source_deposit_instructions": {},
      "payment_methods": {
        "inbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ],
        "outbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ]
      },
      "methods": {
        "inbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ],
        "outbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ]
      },
      "account_holder_name": "<string>",
      "account_number": "<string>",
      "routing_number": "<string>",
      "bank_name": "<string>",
      "bank_address": "<string>",
      "account_holder_address": "<string>",
      "description": "<string>",
      "status_reason": "<string>",
      "markup": {},
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

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

Changed in this version.

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

limit

integer

default:10

Maximum number of virtual accounts to return (1-100).

Required range: 1 <= x <= 100

offset

integer

default:0

Number of virtual accounts to skip for pagination.

Required range: x >= 0

status

enum<string>

Filter by raw account status (not the KYB-mapped value shown on the response).

Available options:

pending,

activating,

active,

failed,

deactivated

user_id

string<uuid>

Filter by owning user UUID.

type

enum<string>

Filter by virtual account type.

Available options:

US_BANK

mode

enum<string>

Filter by funding mode.

Available options:

fiat,

crypto

string

Free-text search (1-255 characters).

Required string length: 1 - 255

metadata

object

Stripe-style metadata filter — ?metadata[key]=value deep-object form. Each key must be 1-40 characters and must not contain [ or ]. Multiple keys are AND-ed.

Show child attributes

Response

Success.

Paginated list envelope (offset-based).

data

object[]

required

Show child attributes

pagination

object

Show child attributes

List virtual accounts

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

import requests

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

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', 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",
  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"

	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")

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

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "approved",
      "type": "US_BANK",
      "mode": "fiat",
      "created_at": "<string>",
      "updated_at": "<string>",
      "bank": "<string>",
      "destination": {},
      "source_deposit_instructions": {},
      "payment_methods": {
        "inbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ],
        "outbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ]
      },
      "methods": {
        "inbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ],
        "outbound": [
          {
            "name": "<string>",
            "status": "<string>"
          }
        ]
      },
      "account_holder_name": "<string>",
      "account_number": "<string>",
      "routing_number": "<string>",
      "bank_name": "<string>",
      "bank_address": "<string>",
      "account_holder_address": "<string>",
      "description": "<string>",
      "status_reason": "<string>",
      "markup": {},
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

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

Authentication

Versioning

Users

Virtual Accounts

Quotations

Payouts

Recipients

Reference

List virtual accounts

Authorizations

Headers

Query Parameters

Response