List virtual account deposits

GET

virtual-accounts

{virtual_account_id}

deposits

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

import requests

url = "https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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))

}

HttpResponse<String> response = Unirest.get("https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/deposits")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/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

[
  {
    "id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb",
    "virtual_account_id": "11111111-2222-3333-4444-555555555555",
    "amount": "1000.00",
    "currency": "USD",
    "status": "COMPLETED",
    "sender": {
      "name": "Acme Corp",
      "account_number": "****6789",
      "address": "123 Market St, San Francisco, CA"
    },
    "recipient": {
      "name": "Alice Smith",
      "company_name": "Northwind Trading LLC",
      "country": "USA"
    },
    "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": null,
      "imad": "20260901MMQFMP3K000123",
      "omad": "20260901L1B7HU5R000456",
      "trace_number": null
    },
    "fees": {
      "base_fees": {
        "fixed_fee": "1.50",
        "percentage_fee": "2.00",
        "fx_markup": "0.00"
      },
      "client_markup": {
        "fixed_fee": "0.00",
        "percentage_fee": "1.00",
        "fx_markup": "0.00"
      },
      "total_fees": "4.50"
    },
    "net_amount": "995.50",
    "net_currency": "USD",
    "created_at": "2026-09-01T14:32:00.000Z",
    "updated_at": "2026-09-01T14:35:10.000Z",
    "metadata": {
      "invoice_id": "INV-2026-0042"
    }
  }
]

{
  "error": "Invalid request data",
  "details": [
    {
      "path": "id",
      "message": "Invalid virtual account ID format",
      "code": "invalid_string"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "The request could not be matched to a valid route, or was malformed. Verify the path and HTTP method against the API reference. This is a routing or request error, not a credentials or signature problem."
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Virtual account 11111111-2222-3333-4444-555555555555 not found",
  "timestamp": "2026-09-01T12:00:00.000Z"
}

Authorizations

Authorization

string

header

required

The data.access_token value from Get access token.

x-api-key

string

header

required

API key issued by Kira.

Headers

X-Api-Version

string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Path Parameters

virtual_account_id

string<uuid>

required

UUID of the account whose deposits you want.

Query Parameters

limit

integer

default:10

How many deposits to return, between 1 and 100, and 10 when you omit it.

Anything outside that range, or anything that is not a number, is brought back into it instead of being rejected.

Required range: 1 <= x <= 100

offset

integer

default:0

How many deposits to skip before the first row returned. Use it with limit to walk the list: offset=0, then offset=10, and so on. 0 when you omit it.

Required range: x >= 0

Response

Success.

string<uuid>

Deposit UUID.

virtual_account_id

string<uuid>

UUID of the account the money arrived in.

amount

string

How much arrived, before charges, as a decimal string.

currency

string

Currency of amount.

status

string

Where the deposit has got to — see Virtual account values. Available options: PENDING, COMPLETED, FAILED, REFUNDED, KYT_PENDING, KYT_REJECTED.

sender

object | null

Who sent the money, as the bank reported it.

Show child attributes

recipient

object

The user who owns the account the money arrived in. Every field is null if that user can no longer be read.

Show child attributes

payment_rail

string | null

How the money travelled, such as wire or ach_push. Mirrors source.payment_rail.

settlement_tx_hash

string | null

On-chain transaction that settled the deposit. null on a fiat account, and until settlement runs.

source

object | null

Who sent the money, plus what the rail recorded about the transfer.

Show child attributes

fees

object

What was charged on this deposit. Every figure is a decimal string, and they are all 0.00 when nothing was charged.

Show child attributes

net_amount

string

amount less total_fees, as a decimal string. Never below 0.00.

net_currency

string

Currency of net_amount.

created_at

string

When the deposit was first recorded, as an ISO 8601 timestamp.

updated_at

string

When it last changed, as an ISO 8601 timestamp.

metadata

object

Key/value pairs attached to the deposit. {} when there are none.

List virtual account deposits

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

import requests

url = "https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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/sandbox/v1/virtual-accounts/{virtual_account_id}/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))

}

HttpResponse<String> response = Unirest.get("https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/deposits")
  .header("Authorization", "Bearer <token>")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/sandbox/v1/virtual-accounts/{virtual_account_id}/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

[
  {
    "id": "77777777-8888-9999-aaaa-bbbbbbbbbbbb",
    "virtual_account_id": "11111111-2222-3333-4444-555555555555",
    "amount": "1000.00",
    "currency": "USD",
    "status": "COMPLETED",
    "sender": {
      "name": "Acme Corp",
      "account_number": "****6789",
      "address": "123 Market St, San Francisco, CA"
    },
    "recipient": {
      "name": "Alice Smith",
      "company_name": "Northwind Trading LLC",
      "country": "USA"
    },
    "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": null,
      "imad": "20260901MMQFMP3K000123",
      "omad": "20260901L1B7HU5R000456",
      "trace_number": null
    },
    "fees": {
      "base_fees": {
        "fixed_fee": "1.50",
        "percentage_fee": "2.00",
        "fx_markup": "0.00"
      },
      "client_markup": {
        "fixed_fee": "0.00",
        "percentage_fee": "1.00",
        "fx_markup": "0.00"
      },
      "total_fees": "4.50"
    },
    "net_amount": "995.50",
    "net_currency": "USD",
    "created_at": "2026-09-01T14:32:00.000Z",
    "updated_at": "2026-09-01T14:35:10.000Z",
    "metadata": {
      "invoice_id": "INV-2026-0042"
    }
  }
]

{
  "error": "Invalid request data",
  "details": [
    {
      "path": "id",
      "message": "Invalid virtual account ID format",
      "code": "invalid_string"
    }
  ]
}

{
  "code": "invalid_request",
  "message": "The request could not be matched to a valid route, or was malformed. Verify the path and HTTP method against the API reference. This is a routing or request error, not a credentials or signature problem."
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Virtual account 11111111-2222-3333-4444-555555555555 not found",
  "timestamp": "2026-09-01T12:00:00.000Z"
}

Across the API

Authentication

Versioning

Users

Virtual Accounts

Recipients

Quotations

Payouts

Catalogs

List virtual account deposits

Authorizations

Headers

Path Parameters

Query Parameters

Response