List Account Numbers

Lists all account details for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/account-details \
  --header 'Authorization: <authorization>'

{
  "message": "Account details retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "account_number": "1234567890",
      "routing_number": "987654321",
      "description": "Primary account details",
      "issuer": {
        "name": "Example Bank",
        "code": "EXBNK",
        "address": "123 Banking St, Finance City",
        "meta": {}
      },
      "config": {
        "outflow_enabled": true,
        "inflow_enabled": true,
        "outflow_allowed_counterparties": [],
        "inflow_allowed_counterparties": []
      },
      "status": "active",
      "terminate_after": 365,
      "created": 1693584000000,
      "updated": 1693584000000,
      "account_summary": {
        "display_name": "Business Account",
        "type": "checking",
        "currency": "USD"
      }
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "account_number": "0987654321",
      "routing_number": "1234567890",
      "description": "Secondary account details",
      "issuer": {
        "name": "Example Bank",
        "code": "EXBNK",
        "address": "123 Banking St, Finance City",
        "meta": {}
      },
      "config": {
        "outflow_enabled": true,
        "inflow_enabled": true,
        "outflow_allowed_counterparties": [],
        "inflow_allowed_counterparties": []
      },
      "status": "active",
      "terminate_after": 365,
      "created": 1693584000000,
      "updated": 1693584000000,
      "account_summary": {
        "display_name": "Savings Account",
        "type": "debit",
        "currency": "USD"
      }
    }
  ],
  "meta": {
    "pagination": {
      "limit": 20,
      "total_count": 2,
      "has_next": false,
      "has_previous": false,
      "next_cursor": null,
      "previous_cursor": null
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "sort": "created_desc"
    }
  }
}

GET

account-details

Lists all account details for the authenticated entity.

curl --request GET \
  --url https://api.nuvion.tech/account-details \
  --header 'Authorization: <authorization>'

{
  "message": "Account details retrieved successfully",
  "status": 200,
  "data": [
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "account_number": "1234567890",
      "routing_number": "987654321",
      "description": "Primary account details",
      "issuer": {
        "name": "Example Bank",
        "code": "EXBNK",
        "address": "123 Banking St, Finance City",
        "meta": {}
      },
      "config": {
        "outflow_enabled": true,
        "inflow_enabled": true,
        "outflow_allowed_counterparties": [],
        "inflow_allowed_counterparties": []
      },
      "status": "active",
      "terminate_after": 365,
      "created": 1693584000000,
      "updated": 1693584000000,
      "account_summary": {
        "display_name": "Business Account",
        "type": "checking",
        "currency": "USD"
      }
    },
    {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "account_number": "0987654321",
      "routing_number": "1234567890",
      "description": "Secondary account details",
      "issuer": {
        "name": "Example Bank",
        "code": "EXBNK",
        "address": "123 Banking St, Finance City",
        "meta": {}
      },
      "config": {
        "outflow_enabled": true,
        "inflow_enabled": true,
        "outflow_allowed_counterparties": [],
        "inflow_allowed_counterparties": []
      },
      "status": "active",
      "terminate_after": 365,
      "created": 1693584000000,
      "updated": 1693584000000,
      "account_summary": {
        "display_name": "Savings Account",
        "type": "debit",
        "currency": "USD"
      }
    }
  ],
  "meta": {
    "pagination": {
      "limit": 20,
      "total_count": 2,
      "has_next": false,
      "has_previous": false,
      "next_cursor": null,
      "previous_cursor": null
    },
    "filters_applied": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "sort": "created_desc"
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Query Parameters

entity_id

string

Filter account details by entity ID

account_id

string

Filter account details by account ID

status

string

Filter account details by status

provider_id

string

Filter account details by provider ID

issuer_name

string

Filter account details by issuer name

issuer_code

string

Filter account details by issuer code

outflow_enabled

boolean

Filter account details by outflow status

inflow_enabled

boolean

Filter account details by inflow status

has_restrictions

boolean

Filter account details by whether they have restrictions

expires_from

number

Filter account details by minimum expiration date (Unix timestamp)

expires_to

number

Filter account details by maximum expiration date (Unix timestamp)

has_termination

boolean

Filter account details by whether they have a termination date

created_from

number

Filter account details by minimum creation date (Unix timestamp)

created_to

number

Filter account details by maximum creation date (Unix timestamp)

limit

number

Maximum number of account details to return per page

cursor

string

Pagination cursor for fetching the next page of results

sort

string

Field and direction to sort the results by

Response

Successful operation

message

string

required

A descriptive message indicating the result of the operation

status

string

required

The status of the API operation (successful, error, failed, pending)

data

object

required

List of account details

Show child attributes

data.id

string

required

Unique identifier for the account details

data.entity_id

string

required

Identifier of the entity that owns the account

data.account_id

string

required

Identifier of the associated account

data.account_number

string

required

Account number for the bank account

data.routing_number

string

required

Routing number for the bank account

data.issuer

object

required

Information about the bank or financial institution that issued the account

Show child attributes

data.issuer.name

string

required

Name of the issuing bank or financial institution

data.issuer.code

string

required

Code or identifier for the issuing bank

data.issuer.address

string

Physical address of the issuing bank

data.issuer.meta

object

Additional metadata about the issuer

data.config

object

required

Configuration options for the account

Show child attributes

data.config.outflow_enabled

boolean

required

Whether outflow (payments from this account) is enabled

data.config.inflow_enabled

boolean

required

Whether inflow (payments to this account) is enabled

data.config.outflow_allowed_counterparties

string[]

List of counterparties allowed for outflow payments

data.config.inflow_allowed_counterparties

string[]

List of counterparties allowed for inflow payments

data.status

string

required

Current status of the account details

data.created

number

required

Timestamp when the account details were created (in milliseconds since epoch)

data.updated

number

required

Timestamp when the account details were last updated (in milliseconds since epoch)

data.account_summary

object

required

Summary information about the associated account

Show child attributes

data.account_summary.display_name

string

required

User-friendly name for the account

data.account_summary.type

string

required

The type of account

data.account_summary.currency

string

required

The currency code for the account

data.description

string

Description of the account details

data.terminate_after

number

Number of days after which the account details will be terminated

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

List Account Numbers

Headers

Query Parameters

Response