approved status before accounts can be created for them.
The Account object
string
Unique account identifier.
string
The ID of the entity this account belongs to.
string
Account type. One of
checking, debit, operational, or safeguard.string
ISO 4217 currency code.Fiat: E.g.
USD, GBP, EUR, NGN, KESStablecoin: USC (USDC), UST (USDT), RLDstring
Human-readable label for the account.
string
Nuvion internal bank account number used for routing. Treat this as read-only.
object
Current balance state of the account. All amounts are in the smallest currency unit (e.g. cents for USD).
string
Unique identifier for the account’s underlying balance record.
object
Account-level configuration.
object
Stablecoin-specific balance detail. Empty for fiat accounts.
boolean
Whether this account is excluded from maintenance fees.
object
Internal metadata reserved for Nuvion. Not settable via the API.
object
Set of key-value pairs for storing additional platform-defined data.
number
0 if the account is active. Non-zero if the account has been deleted.number
Unix timestamp in milliseconds when the account was created.
number
Unix timestamp in milliseconds when the account was last updated.
Example
Always use
balance.available when checking if an entity has sufficient funds. balance.current includes amounts pending settlement that are not yet spendable.Create an account
POST /accounts
Creates a new account for an approved entity. The entity must have status: "approved" before accounts can be opened.
Request parameters
string
The ID of the entity to open this account for. The entity must have
status: "approved". Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.string
required
Account type. One of
checking, debit, operational, or safeguard.string
required
ISO 4217 currency code for the account.
string
required
Human-readable label for the account. Maximum 100 characters.
object
Key-value metadata to attach to the account. Values must be strings.
Response
Returns the created account object. The balance is0 for both available and current at creation.
Response
object
Returned only when creating an account. Summarizes the effect this account had on the owning entity.
Get an account
GET /accounts/{account_id}
Retrieves an existing account by ID.
Path parameters
string
required
The ID of the account to retrieve.
Query parameters
string
The ID of the entity that owns the account. Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.
Response
Returns the account object.Response
Update an account
PATCH /accounts/{account_id}
Updates an existing account. Only display_name can be changed after creation.
Path parameters
string
required
The ID of the account to update.
Request parameters
string
required
New human-readable label for the account. Maximum 100 characters. This is the only field that can be updated after creation.
string
Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.
Response
Returns the updated account object, along with a summary of what changed.Response
Delete an account
DELETE /accounts/{account_id}
Deletes an account. The account must have a zero balance before it can be deleted. Related account details and pinned-account references are removed as part of the same request.
Path parameters
string
required
The ID of the account to delete.
Request parameters
string
Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.
Response
Response
object
The deleted account.
object
Summary of the effect on the owning entity.
object
Whether and how the deletion can be reversed.
List accounts
GET /accounts
Returns a paginated list of accounts. Filter by entity, currency, or account type.
Query parameters
string
Filter accounts by entity ID. Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.
string
Filter by ISO 4217 currency code (e.g.
USD).string
Filter by account type. One of
checking, debit, operational, or safeguard.integer
Number of results to return. Between 1 and 100. Defaults to
20.string
Pagination cursor from a previous response. Omit for the first page.
Response
Returns a paginated list of account objects.Response
Get account statements
GET /accounts/{account_id}/statements
Retrieves a statement of transactions for an account over a given month.
Path parameters
string
required
The ID of the account to generate a statement for.
Query parameters
integer
required
The statement year. e.g.
2026.integer
required
The statement month.
1–12.integer
Number of transactions to return. Between 1 and 100. Defaults to
20.boolean
Whether to include transactions that haven’t settled yet. Defaults to
false.string
Defaults to the authenticating entity when omitted. Required when acting on a child entity. See Managing child entities for details.
Response
Returns a statement summary with matching transactions for the requested period.Pending transactions haven’t settled yet, so they don’t affect
running_balance or the summary balances totals until they complete.string
The ID of the account this statement covers.
string
Name on the account at the time the statement was generated.
string
ISO 4217 currency code of the account.
string
Nuvion internal bank account number for the account.
object
Postal address on file for the account holder at the time the statement was generated.
string
ISO 8601 timestamp of when the statement was generated.
object
The date range the statement covers.
object
Summary totals for the statement period. All amounts are in the smallest currency unit.
array
Transactions that occurred in the statement period, ordered oldest to newest.
object
Pagination detail for the transaction list.
Response
