List Vault Balances

Lists a vault’s balance entries.

GET /vaults/{vaultId}/balances

List Vault Balances

cURL

curl --request GET \
  --url https://api.dfns.io/vaults/{vaultId}/balances \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dfns.io/vaults/{vaultId}/balances"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.dfns.io/vaults/{vaultId}/balances', 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.dfns.io/vaults/{vaultId}/balances",
  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>"
  ],
]);

$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.dfns.io/vaults/{vaultId}/balances"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.dfns.io/vaults/{vaultId}/balances")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dfns.io/vaults/{vaultId}/balances")

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

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

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

200

{
  "items": [
    {
      "id": "<string>",
      "network": "<string>",
      "tid": "<string>",
      "amount": "<string>",
      "transferId": "<string>",
      "quarantineId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

Required Permissions

Vaults:Read: Always required.

Authorizations

Authorization · string · header · required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

Path Parameters

vaultId · string · required

Vault id.

Required string length: 1 - 64

Pattern: ^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Query Parameters

limit · integer · default: 50

Maximum number of items to return.

Required range: 1 <= x <= 500

paginationToken · string

Opaque token used to retrieve the next page. Returned as nextPageToken from the previous request.

Minimum string length: 1

kind · enum<string>

Vault balance kind.

Available options: Available, Outgoing, Fee, Incoming, Locked, Quarantined

network · string

tid · string

Response

200 - application/json

Success

items · object[] · required

Show child attributes

nextPageToken · string