Return Financial Accounts
The GET /api/financialAccounts/v2 endpoint retrieves all financial accounts linked to the authenticated user's profile. Each account record includes identifying details such as account number, routing number, current and available balances, account type, and enabled features. The response also provides aggregate totals across all accounts, making it easy to display a consolidated financial overview in a single request.
Endpoint
GET /api/financialAccounts/v2
Authentication
Bearer token required. Obtain via:
POST https://api.banking.netevia.dev/api/auth/v2
Include in header: Authorization: Bearer {token}
Token lifetime: 10 minutes. Refresh via POST /api/auth/refresh.
When to use
Use this endpoint to render a customer's complete account dashboard, showing all active financial accounts with their current balances and statuses. It is the primary call for account management screens where users need to select a source or destination account for transfers, card funding, or rewards redemption. Because it returns aggregate totals alongside individual account data, it is well-suited for summary views and reporting features.
Response
200 OK
Top-level object
| Field | Type | Description |
|---|---|---|
financialAccounts | array of objects | List of financial account records for the authenticated user. |
totals | object | Aggregate balance totals across all financial accounts. |
financialAccounts[] object
| Field | Type | Description |
|---|---|---|
financialAccountId | string | Unique identifier for the financial account. |
name | string | Display name assigned to the account. |
accountNumber | string | The account number associated with this financial account. |
routingNumber | string | The routing number for the financial account. |
status | string | Current status of the account (e.g., Active, Suspended, Closed). |
availableCash | object | Available balance available for immediate use. See Amount object below. |
cash | object | Current ledger balance of the account. See Amount object below. |
created | string (date-time) | ISO 8601 timestamp of when the account was created. |
isPrimary | boolean | Whether this is the user's primary financial account. |
cashIn | integer (int64) | Total funds received into the account (in minor currency units). |
cashOut | integer (int64) | Total funds sent out of the account (in minor currency units). |
accountType | string | Type classification of the account (e.g., Checking, Savings). |
partnerName | string | Name of the partner associated with this account. |
features | array of strings | List of features enabled for this account. Possible values: GiftCardPurchase, RedeemsPoints, AutoPopup, Transfer, OpenPaymentCard. |
isLockAccount | boolean | Whether the account is currently locked. |
isProductFundingAccount | boolean | Whether this account is designated as a product funding account. |
Amount object (availableCash, cash)
| Field | Type | Description |
|---|---|---|
value | integer (int64) | Monetary amount in minor currency units (e.g., cents). |
currencyCode | string | ISO 4217 currency code (e.g., USD). |
totals object
| Field | Type | Description |
|---|---|---|
cashIn | integer (int64) | Sum of all funds received across all accounts (in minor currency units). |
cashOut | integer (int64) | Sum of all funds sent across all accounts (in minor currency units). |
cash | integer (int64) | Sum of current ledger balances across all accounts (in minor currency units). |
availableCash | integer (int64) | Sum of available balances across all accounts (in minor currency units). |
{
"financialAccounts": [
{
"financialAccountId": "fa_01HXYZ1234ABCDEF5678",
"name": "Business Checking",
"accountNumber": "XXXXXXXXXX",
"routingNumber": "021000021",
"status": "Active",
"availableCash": {
"value": 250000,
"currencyCode": "USD"
},
"cash": {
"value": 275000,
"currencyCode": "USD"
},
"created": "2024-03-15T10:22:00Z",
"isPrimary": true,
"cashIn": 1000000,
"cashOut": 725000,
"accountType": "Checking",
"partnerName": "Netevia Partner",
"features": [
"Transfer",
"OpenPaymentCard",
"RedeemsPoints"
],
"isLockAccount": false,
"isProductFundingAccount": false
},
{
"financialAccountId": "fa_01HXYZ5678GHIJKL9012",
"name": "Savings Reserve",
"accountNumber": "XXXXXXXXXX",
"routingNumber": "021000021",
"status": "Active",
"availableCash": {
"value": 500000,
"currencyCode": "USD"
},
"cash": {
"value": 500000,
"currencyCode": "USD"
},
"created": "2024-04-01T08:00:00Z",
"isPrimary": false,
"cashIn": 600000,
"cashOut": 100000,
"accountType": "Savings",
"partnerName": "Netevia Partner",
"features": [
"Transfer"
],
"isLockAccount": false,
"isProductFundingAccount": false
}
],
"totals": {
"cashIn": 1600000,
"cashOut": 825000,
"cash": 775000,
"availableCash": 750000
}
}Error Codes
| Code | When it happens |
|---|---|
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to access financial accounts |
| 500 | Internal server error |
Common Mistakes
- Treating
valueinavailableCashandcashas dollars — these are in minor currency units (cents). Divide by 100 to display a dollar amount (e.g.,250000= $2,500.00). - Assuming the response includes external accounts linked via Finicity or Plaid — this endpoint returns only Netevia-hosted financial accounts.
- Not handling the
featuresarray — some account operations (e.g., opening a payment card or redeeming points) are only available if the corresponding feature is present in this list. - Expecting more than 5 accounts by default — each customer is limited to 5 active financial accounts unless the limit has been extended by the partner.
Related Endpoints
POST /api/financialAccounts/v2— Create a new financial account for a customerGET /api/financialAccounts/v2/{financialAccountId}— Retrieve details for a specific financial accountPOST /api/transfers/v2— Initiate a transfer between financial accountsGET /api/transactions/v2— Retrieve transaction history for a financial account
Example
curl -X GET https://api.banking.netevia.dev/api/financialAccounts/v2 \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"