Get Financial Accounts with Details
This endpoint returns a full list of financial accounts linked to a user profile, including account numbers, routing numbers, available cash balances, account status, and associated card product configurations. It is the primary method for obtaining a complete overview of a customer's financial account portfolio within the Netevia platform.
Endpoint
GET /netevia/financialAccount/details
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 when you need to display a full summary of a user's financial accounts in a banking application dashboard. It is suitable for retrieving account numbers, balances, and card profile assignments in a single call. This endpoint is also useful for account management workflows where you need to verify account status or identify which card products are linked to each account.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | integer (int32) | No | The unique identifier of the user profile whose financial accounts should be retrieved. If omitted, defaults to the authenticated user's profile. |
| withPartners | boolean | No | When true, includes partner-linked accounts in the response. Defaults to false. |
| withStatus | integer (int32) | No | Filters accounts by status. Accepted values: 0, 1, 2, 3, 4 corresponding to the financial account status enum. |
Response
200 OK
Returns an array of financial account detail objects.
Financial Account Details Object (financialaccountdetailsmodel)
financialaccountdetailsmodel)| Field | Type | Description |
|---|---|---|
| financialAccountId | string | Unique identifier for the financial account. |
| userProfileId | integer (int32) | The profile ID of the account owner. |
| name | string | Display name of the financial account. |
| accountNumber | string | The account number associated with this financial account. |
| routingNumber | string | The routing number for ACH transactions. |
| status | string | Current status of the financial account (e.g., ACTIVE, SUSPENDED). |
| availableCash | integer (int64) | Available cash balance in the account, expressed in cents. |
| created | string (date-time) | ISO 8601 timestamp of when the account was created. |
| cardProfileSets | array | List of card profile set configurations associated with this account. Each entry may be a cardprofileset or cardprofilesetresponse object. |
| cardProduct | object | The card product linked to this financial account. See cardproductresponse below. |
| isLockBoxAccount | boolean | Indicates whether this account is a lockbox account. |
Card Product Object (cardproductresponse)
cardproductresponse)| Field | Type | Description |
|---|---|---|
| name | string | Display name of the card product. |
| id | string | Unique identifier of the card product. |
| usage | string | Intended usage category of the card product. |
Card Profile Set Object (cardprofileset)
cardprofileset)| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier of the card profile set. |
| name | string | Name of the card profile set. |
| intent | string | Intended purpose or intent of the card profile set. |
| network | string | Payment network associated with the card profile set (e.g., VISA, MASTERCARD). |
| status | string | Current status of the card profile set. |
| cardProductId | string | ID of the card product this profile set belongs to. |
| displayName | string | User-facing display name for the card profile set. |
| isDefault | boolean | Whether this is the default card profile set for the account. |
| description | string | Description of the card profile set. |
Card Profile Set Response Object (cardprofilesetresponse)
cardprofilesetresponse)Extends cardprofileset with the following additional fields:
| Field | Type | Description |
|---|---|---|
| cardDesign | object | Card design settings including front and back image URLs. See carddesignsettings below. |
Card Design Settings Object (carddesignsettings)
carddesignsettings)| Field | Type | Description |
|---|---|---|
| frontSideImageUrlXs | string | Small (XS) front side image URL for the standard card design. |
| frontSideImageUrlXl | string | Large (XL) front side image URL for the standard card design. |
| backSideImageUrlXl | string | Large (XL) back side image URL for the standard card design. |
| burnerFrontSideImageUrlXs | string | Small (XS) front side image URL for the burner card design. |
| burnerFrontSideImageUrlXl | string | Large (XL) front side image URL for the burner card design. |
| burnerBackSideImageUrlXl | string | Large (XL) back side image URL for the burner card design. |
[
{
"financialAccountId": "fa-7a3b92e1-4c5d-4f8a-b123-abc456def789",
"userProfileId": 10245,
"name": "Primary Checking",
"accountNumber": "XXXXXXXXXX",
"routingNumber": "021000021",
"status": "ACTIVE",
"availableCash": 524750,
"created": "2024-03-15T10:22:00Z",
"cardProfileSets": [
{
"id": "cps-001",
"name": "Standard Visa Debit",
"intent": "DEBIT",
"network": "VISA",
"status": "ACTIVE",
"cardProductId": "cp-visa-debit-001",
"displayName": "Netevia Visa Debit",
"isDefault": true,
"description": "Standard debit card profile for everyday spending",
"cardDesign": {
"frontSideImageUrlXs": "https://assets.netevia.com/cards/visa-debit-front-xs.png",
"frontSideImageUrlXl": "https://assets.netevia.com/cards/visa-debit-front-xl.png",
"backSideImageUrlXl": "https://assets.netevia.com/cards/visa-debit-back-xl.png",
"burnerFrontSideImageUrlXs": "https://assets.netevia.com/cards/burner-front-xs.png",
"burnerFrontSideImageUrlXl": "https://assets.netevia.com/cards/burner-front-xl.png",
"burnerBackSideImageUrlXl": "https://assets.netevia.com/cards/burner-back-xl.png"
}
}
],
"cardProduct": {
"name": "Netevia Visa Debit",
"id": "cp-visa-debit-001",
"usage": "CONSUMER"
},
"isLockBoxAccount": false
}
]Error Codes
| Code | When it happens |
|---|---|
| 400 | Missing required fields or invalid query parameter values |
| 401 | Token missing, expired, or invalid |
| 403 | Insufficient permissions to access the requested profile's accounts |
| 404 | No financial accounts found for the given profile |
| 500 | Internal server error |
Common Mistakes
- Passing an invalid or non-integer value for
profileIdorwithStatuswill result in a 400 error; ensure these are properly typed integers. - The
availableCashfield is returned in cents (smallest currency unit), not dollars — divide by 100 to display a dollar amount to end users. - Omitting
profileIdwhen acting on behalf of a specific customer will return accounts for the authenticated user instead of the intended customer. - The
withStatusparameter accepts only the integer values0–4from the status enum; passing string status labels will be rejected. - Account numbers in the response should be masked when displayed to end users; never expose raw account numbers in a client-facing UI.
Related Endpoints
GET /netevia/financialAccount— Retrieve a lightweight list of financial accounts without full detailsPOST /netevia/financialAccount— Create a new financial account for a customer profileGET /netevia/financialAccount/{financialAccountId}— Retrieve details for a single financial account by IDGET /netevia/financialAccount/{financialAccountId}/transactions— Retrieve transaction history for a specific financial account
Example
curl -X GET "https://api.banking.netevia.dev/netevia/financialAccount/details?profileId=10245&withPartners=false&withStatus=1" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"