Skip to main content
POST
Create account

Overview

This endpoint creates a new virtual account based on the specified account type.
  • For third-party accounts (business use), set third_party to true and provide a customer_id.
  • For sub-accounts (collections), set third_party to false and provide an account_name.
  • If third_party is not specified, it defaults to true.

Endpoint

POST /accounts

Request Body

Standard Account Creation (Business Use)

Sub-Account Creation (Collections)

Response

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Body

application/json

Create a new virtual account based on account type

account_type
enum<string>
required

The type of account to create (static or dynamic)

Available options:
static,
dynamic
third_party
boolean
default:true

For third-party accounts (business use), set to true. For sub-accounts (collections), set to false.

customer_id
string

Required if third_party is true. The ID of the customer.

account_name
string

Required if third_party is false. The name of the collection account.

Response

200 - application/json

OK

The response is of type object.