Retrieve a financial account

GET

financial_accounts

{fa_id}

curl --request GET \
  --url https://api.nova.net/v1/financial_accounts/{fa_id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.nova.net/v1/financial_accounts/{fa_id}', 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.nova.net/v1/financial_accounts/{fa_id}",
  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.nova.net/v1/financial_accounts/{fa_id}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.nova.net/v1/financial_accounts/{fa_id}")

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

{
  "object": "financial_account",
  "livemode": true,
  "id": "fa_RoYxEYPaMtOgRX7lDYzfxVE14uPK",
  "vehicle": "veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w",
  "name": "Acme Trust LLC (7862)",
  "type": "depository",
  "bank_name": "Goldman Lynch",
  "account_number_last_four": "7862",
  "balance": {
    "total": 125000,
    "available": 125000,
    "total_end_of_last_month": 125000,
    "currency": "USD"
  },
  "created_at": "2024-04-20T01:00:00.000Z",
  "updated_at": "2024-04-20T01:00:00.000Z"
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

FlowClient Credentials

Token URL: /oauth/token

Scopes1

financial_accounts:read

Read financial account data

Headers

X-Organization-Id

string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Pattern: ^org_[A-Za-z0-9]+$

Example:

"org_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Path Parameters

fa_id

string

required

ID of the financial account

Pattern: ^fa_[A-Za-z0-9]+$

Example:

"fa_RoYxEYPaMtOgRX7lDYzfxVE14uPK"

Response

The financial account

object

enum<string>

required

Object type identifier.

Available options:

financial_account

Example:

"financial_account"

livemode

boolean

required

Whether this object exists in live mode (true) or test mode (false).

string

required

ID of the financial account

Pattern: ^fa_[A-Za-z0-9]+$

Example:

"fa_RoYxEYPaMtOgRX7lDYzfxVE14uPK"

vehicle

string

required

ID of the vehicle that holds this account

Pattern: ^veh_[A-Za-z0-9]+$

Example:

"veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w"

name

string

required

Name of the account

Example:

"Acme Trust LLC (7862)"

type

enum<string>

required

Kind of account: 'depository', 'brokerage'

Available options:

depository,

brokerage

Example:

"depository"

bank_name

string | null

required

Name of the partner bank that holds the account.

Example:

"Goldman Lynch"

account_number_last_four

string | null

required

Last four digits.

Example:

"7862"

balance

object

required

Show child attributes

created_at

string<date-time>

required

Example:

"2024-04-20T01:00:00.000Z"

updated_at

string<date-time>

required

Example:

"2024-04-20T01:00:00.000Z"

Retrieve a financial account

curl --request GET \
  --url https://api.nova.net/v1/financial_accounts/{fa_id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.nova.net/v1/financial_accounts/{fa_id}', 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.nova.net/v1/financial_accounts/{fa_id}",
  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.nova.net/v1/financial_accounts/{fa_id}"

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

}

require 'uri'
require 'net/http'

url = URI("https://api.nova.net/v1/financial_accounts/{fa_id}")

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

{
  "object": "financial_account",
  "livemode": true,
  "id": "fa_RoYxEYPaMtOgRX7lDYzfxVE14uPK",
  "vehicle": "veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w",
  "name": "Acme Trust LLC (7862)",
  "type": "depository",
  "bank_name": "Goldman Lynch",
  "account_number_last_four": "7862",
  "balance": {
    "total": 125000,
    "available": 125000,
    "total_end_of_last_month": 125000,
    "currency": "USD"
  },
  "created_at": "2024-04-20T01:00:00.000Z",
  "updated_at": "2024-04-20T01:00:00.000Z"
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

{
  "object": "error",
  "type": "invalid_request_error",
  "code": "parameter_invalid",
  "message": "The 'limit' parameter must be between 1 and 100.",
  "status": 400,
  "invalid-params": [
    {
      "code": "parameter_invalid",
      "name": "body.[0].limit",
      "value": 200,
      "reason": "out of range"
    }
  ]
}

Distributions

Payment Instructions

Entities

Contacts

Organizations

Vehicles

Financial Accounts

Retrieve a financial account

Authorizations

Headers

Path Parameters

Response