Skip to main content
POST
/
accounts
Creates a new account for the authenticated entity.
curl --request POST \
  --url https://api.nuvion.tech/accounts \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "debit",
  "currency": "USD",
  "display_name": "My Primary Account",
  "meta": {
    "purpose": "Personal expenses",
    "category": "primary"
  },
  "config": {
    "is_overdraftable": false,
    "overdraft_limit": 0
  }
}
'
{
  "message": "Account created successfully",
  "status": 201,
  "data": {
    "account": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "type": "debit",
      "currency": "USD",
      "display_name": "My Primary Account",
      "meta": {},
      "config": {
        "is_overdraftable": false,
        "overdraft_limit": 0
      },
      "created": 1693584000000,
      "updated": 1693584000000,
      "balance": {
        "available": 0,
        "current": 0,
        "overdraft_used": 0
      }
    },
    "entity_impact": {
      "entity_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "total_accounts": 1,
      "account_type": [
        "debit"
      ],
      "default_account_set": true
    }
  }
}

Headers

Authorization
string
required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json
type
string
required

The type of account to create

currency
string
required

The three-letter ISO currency code for the account

display_name
string
required

A user-friendly name for the account

meta
object

Additional metadata associated with the account

config
object

Configuration settings for the account

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