Retrieve an Account Number

Retrieves account detail information for the authenticated entity.

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

{
  "message": "Account detail retrieved successfully",
  "status": 200,
  "data": {
    "account_detail": {
      "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
    },
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "name": "Acme Corporation",
      "type": "business",
      "verification_status": "verified"
    },
    "account": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "checking",
      "currency": "USD",
      "display_name": "Business Account",
      "meta": {},
      "config": {
        "is_overdraftable": false,
        "overdraft_limit": 0
      },
      "created": 1693584000000,
      "updated": 1693584000000,
      "balance": {
        "available": 0,
        "current": 0,
        "overdraft_used": 0
      }
    },
    "usage_statistics": {
      "total_transactions": 127,
      "successful_transactions": 124,
      "failed_transactions": 3,
      "last_transaction_date": 1735689600000,
      "total_volume_by_currency": [
        {
          "currency": "USD",
          "inflow_volume": 250000.75,
          "outflow_volume": 180000.5
        }
      ]
    }
  }
}

GET

account-details

{detailId}

Retrieves account detail information for the authenticated entity.

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

{
  "message": "Account detail retrieved successfully",
  "status": 200,
  "data": {
    "account_detail": {
      "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
    },
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "name": "Acme Corporation",
      "type": "business",
      "verification_status": "verified"
    },
    "account": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "checking",
      "currency": "USD",
      "display_name": "Business Account",
      "meta": {},
      "config": {
        "is_overdraftable": false,
        "overdraft_limit": 0
      },
      "created": 1693584000000,
      "updated": 1693584000000,
      "balance": {
        "available": 0,
        "current": 0,
        "overdraft_used": 0
      }
    },
    "usage_statistics": {
      "total_transactions": 127,
      "successful_transactions": 124,
      "failed_transactions": 3,
      "last_transaction_date": 1735689600000,
      "total_volume_by_currency": [
        {
          "currency": "USD",
          "inflow_volume": 250000.75,
          "outflow_volume": 180000.5
        }
      ]
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Path Parameters

detailId

string

required

The unique identifier (ULID) of the account detail to retrieve

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

The data returned from the operation

Show child attributes

data.account_detail

object

required

Detailed information about the account details

Show child attributes

data.account_detail.id

string

required

Unique identifier for the account details

data.account_detail.entity_id

string

required

Identifier of the entity that owns the account

data.account_detail.account_id

string

required

Identifier of the associated account

data.account_detail.account_number

string

required

Account number for the bank account

data.account_detail.routing_number

string

required

Routing number for the bank account

data.account_detail.issuer

object

required

Information about the bank or financial institution that issued the account

Show child attributes

data.account_detail.issuer.name

string

required

Name of the issuing bank or financial institution

data.account_detail.issuer.code

string

required

Code or identifier for the issuing bank

data.account_detail.issuer.address

string

Physical address of the issuing bank

data.account_detail.issuer.meta

object

Additional metadata about the issuer

data.account_detail.config

object

required

Configuration options for the account

Show child attributes

data.account_detail.config.outflow_enabled

boolean

required

Whether outflow (payments from this account) is enabled

data.account_detail.config.inflow_enabled

boolean

required

Whether inflow (payments to this account) is enabled

data.account_detail.config.outflow_allowed_counterparties

string[]

List of counterparties allowed for outflow payments

data.account_detail.config.inflow_allowed_counterparties

string[]

List of counterparties allowed for inflow payments

data.account_detail.status

string

required

Current status of the account details

data.account_detail.created

number

required

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

data.account_detail.updated

number

required

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

data.account_detail.description

string

Description of the account details

data.account_detail.terminate_after

number

Number of days after which the account details will be terminated

data.entity

object

required

Information about the entity that owns the account

Show child attributes

data.entity.id

string

required

Unique identifier for the entity

data.entity.name

string

required

Name of the entity

data.entity.type

string

required

Type of the entity

data.entity.verification_status

string

required

Verification status of the entity

data.account

object

required

Information about the associated account

Show child attributes

data.account.id

string

required

Unique identifier for the account

data.account.entity_id

string

required

Identifier of the entity that owns the account

data.account.type

string

required

The type of account

data.account.currency

string

required

The currency code for the account

data.account.display_name

string

required

User-friendly name for the account

data.account.config

object

required

Configuration options for the account

Show child attributes

data.account.config.is_overdraftable

boolean

required

Whether the account can be overdrawn

data.account.config.overdraft_limit

number

required

Maximum amount the account can be overdrawn by

data.account.created

number

required

Timestamp when the account was created (in milliseconds since epoch)

data.account.updated

number

required

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

data.account.balance

object

required

Current balance information for the account

Show child attributes

data.account.balance.available

number

required

Available balance that can be spent

data.account.balance.current

number

required

Current total balance including pending transactions

data.account.balance.overdraft_used

number

required

Amount of overdraft currently being used

data.account.meta

object

Additional metadata for the account

data.usage_statistics

object

required

Statistics about the usage of the account

Show child attributes

data.usage_statistics.total_transactions

number

required

Total number of transactions performed with this account

data.usage_statistics.successful_transactions

number

required

Number of successful transactions

data.usage_statistics.failed_transactions

number

required

Number of failed transactions

data.usage_statistics.total_volume_by_currency

object

required

Total transaction volume grouped by currency

Show child attributes

data.usage_statistics.total_volume_by_currency.currency

string

required

Currency code

data.usage_statistics.total_volume_by_currency.inflow_volume

number

required

Total volume of money flowing into the account

data.usage_statistics.total_volume_by_currency.outflow_volume

number

required

Total volume of money flowing out of the account

data.usage_statistics.last_transaction_date

number

Timestamp of the last transaction (in milliseconds since epoch)

List Account Numbers Create a Counterparty or Transfer recipient

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Retrieve an Account Number

Headers

Path Parameters

Response