Return financial accounts

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

FieldTypeDescription
financialAccountsarray of objectsList of financial account records for the authenticated user.
totalsobjectAggregate balance totals across all financial accounts.

financialAccounts[] object

FieldTypeDescription
financialAccountIdstringUnique identifier for the financial account.
namestringDisplay name assigned to the account.
accountNumberstringThe account number associated with this financial account.
routingNumberstringThe routing number for the financial account.
statusstringCurrent status of the account (e.g., Active, Suspended, Closed).
availableCashobjectAvailable balance available for immediate use. See Amount object below.
cashobjectCurrent ledger balance of the account. See Amount object below.
createdstring (date-time)ISO 8601 timestamp of when the account was created.
isPrimarybooleanWhether this is the user's primary financial account.
cashIninteger (int64)Total funds received into the account (in minor currency units).
cashOutinteger (int64)Total funds sent out of the account (in minor currency units).
accountTypestringType classification of the account (e.g., Checking, Savings).
partnerNamestringName of the partner associated with this account.
featuresarray of stringsList of features enabled for this account. Possible values: GiftCardPurchase, RedeemsPoints, AutoPopup, Transfer, OpenPaymentCard.
isLockAccountbooleanWhether the account is currently locked.
isProductFundingAccountbooleanWhether this account is designated as a product funding account.

Amount object (availableCash, cash)

FieldTypeDescription
valueinteger (int64)Monetary amount in minor currency units (e.g., cents).
currencyCodestringISO 4217 currency code (e.g., USD).

totals object

FieldTypeDescription
cashIninteger (int64)Sum of all funds received across all accounts (in minor currency units).
cashOutinteger (int64)Sum of all funds sent across all accounts (in minor currency units).
cashinteger (int64)Sum of current ledger balances across all accounts (in minor currency units).
availableCashinteger (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

CodeWhen it happens
401Token missing, expired, or invalid
403Insufficient permissions to access financial accounts
500Internal server error

Common Mistakes

  • Treating value in availableCash and cash as 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 features array — 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 customer
  • GET /api/financialAccounts/v2/{financialAccountId} — Retrieve details for a specific financial account
  • POST /api/transfers/v2 — Initiate a transfer between financial accounts
  • GET /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"
Query Params
boolean
Defaults to false
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json