Generate an Account Number

Creates new account details for the authenticated entity.

curl --request POST \
  --url https://api.nuvion.tech/account-details \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
  "config": {
    "outflow_enabled": true,
    "inflow_enabled": true,
    "outflow_allowed_counterparties": [
      "01HJ5G6R7MXW5ZK2QD6YA8N9F6"
    ],
    "inflow_allowed_counterparties": [
      "01HJ5G6R7MXW5ZK2QD6YA8N9F7"
    ]
  },
  "terminate_after": 365,
  "provider_id": "primary_provider"
}
'

{
  "message": "Account detail created successfully",
  "status": 201,
  "data": {
    "account_details": {
      "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
    }
  }
}

POST

account-details

Creates new account details for the authenticated entity.

curl --request POST \
  --url https://api.nuvion.tech/account-details \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
  "config": {
    "outflow_enabled": true,
    "inflow_enabled": true,
    "outflow_allowed_counterparties": [
      "01HJ5G6R7MXW5ZK2QD6YA8N9F6"
    ],
    "inflow_allowed_counterparties": [
      "01HJ5G6R7MXW5ZK2QD6YA8N9F7"
    ]
  },
  "terminate_after": 365,
  "provider_id": "primary_provider"
}
'

{
  "message": "Account detail created successfully",
  "status": 201,
  "data": {
    "account_details": {
      "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
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json

account_id

string

required

The unique identifier (ULID) of the account to associate with these details

config

object

Configuration settings for the account details

Show child attributes

config.outflow_enabled

boolean

Whether outgoing transactions are enabled for this account

config.inflow_enabled

boolean

Whether incoming transactions are enabled for this account

config.outflow_allowed_counterparties

string[]

List of counterparty IDs allowed for outgoing transactions

config.inflow_allowed_counterparties

string[]

List of counterparty IDs allowed for incoming transactions.

terminate_after

number

Number of days after which the account details should be terminated

provider_id

string

Identifier for the provider to use for account issuance

asset_type

string

Specify stablecoin or fiat. This defaults to fiat.`

chain

string

Specify eth or sol for Ethereum or Solana wallets when asset_type is stablecoin.

Response

Created successfully

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_details

object

required

Details of the created account

Show child attributes

data.account_details.id

string

required

Unique identifier for the account details

data.account_details.entity_id

string

required

Identifier of the entity that owns the account

data.account_details.account_id

string

required

Identifier of the associated account

data.account_details.account_number

string

required

Account number for the bank account

data.account_details.routing_number

string

required

Routing number for the bank account

data.account_details.issuer

object

required

Information about the bank or financial institution that issued the account

Show child attributes

data.account_details.issuer.name

string

required

Name of the issuing bank or financial institution

data.account_details.issuer.code

string

required

Code or identifier for the issuing bank

data.account_details.issuer.address

string

Physical address of the issuing bank

data.account_details.issuer.meta

object

Additional metadata about the issuer

data.account_details.config

object

required

Configuration options for the account

Show child attributes

data.account_details.config.outflow_enabled

boolean

required

Whether outflow (payments from this account) is enabled

data.account_details.config.inflow_enabled

boolean

required

Whether inflow (payments to this account) is enabled

data.account_details.config.outflow_allowed_counterparties

string[]

List of counterparties allowed for outflow payments

data.account_details.config.inflow_allowed_counterparties

string[]

List of counterparties allowed for inflow payments

data.account_details.status

string

required

Current status of the account details

data.account_details.created

number

required

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

data.account_details.updated

number

required

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

data.account_details.description

string

Description of the account details

data.account_details.terminate_after

number

Number of days after which the account details will be terminated

Delete an account List Account Numbers

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Generate an Account Number

Headers

Body

Response