Open Financial Account

Opens a new financial account for a customer within the Netevia Banking platform.

Open Financial Account

The Open Financial Account endpoint allows partners to create a new financial account for a customer within the Netevia Banking platform. By supplying the required account name and an optional application identifier, the API provisions the account and returns a confirmation string. Both personal and business customers may open accounts, subject to the platform limit of up to 5 financial accounts per customer.

Endpoint

POST /api/financialAccounts/open

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 onboarding a new customer and a financial account needs to be created for them, or when an existing customer requests an additional account (checking, savings, or other supported account types). It is also used during programmatic account setup flows where an external application ID must be linked to the new account for downstream reconciliation.

Query Parameters

ParameterTypeRequiredDescription
NamestringYesThe display name for the new financial account (e.g., "Business Checking", "Personal Savings").
OpenApplicationIdstringNoAn external application or workflow identifier to associate with the account opening request, used for tracking and reconciliation.

Response

200 OK

The response is a plain string confirming the result of the account creation request (e.g., the new account identifier or a status message).

FieldTypeDescription
(body)stringConfirmation value returned upon successful account creation, typically the new account ID or a status indicator.
"acc_9f3a2d1e7c4b"

Error Codes

CodeWhen it happens
400Missing required fields or validation error (e.g., Name query parameter not provided)
401Token missing, expired, or invalid
403Insufficient permissions or customer has reached the maximum number of allowed financial accounts
404Resource not found (e.g., referenced customer or application ID does not exist)
500Internal server error

Common Mistakes

  • Omitting the required Name query parameter, which causes a 400 validation error.
  • Attempting to open more than 5 financial accounts for a single customer without requesting a limit increase.
  • Passing an expired Bearer token; tokens expire after 10 minutes and must be refreshed before making account creation calls.
  • Sending account details in a JSON request body instead of as query parameters — this endpoint uses query parameters exclusively.

Related Endpoints

  • GET /api/financialAccounts — Retrieve a list of financial accounts for the authenticated customer
  • GET /api/financialAccounts/{id} — Retrieve details for a specific financial account
  • POST /api/auth/v2 — Obtain a Bearer token for authentication
  • POST /api/auth/refresh — Refresh an existing Bearer token

Example

curl -X POST "https://api.banking.netevia.dev/api/financialAccounts/open?Name=Business%20Checking&OpenApplicationId=app-20240601-001" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
Query Params
string
required
string
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