Skip to main content
POST
JavaScript

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Headers

Idempotency-Key
string

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

The legal name of the Subaccount

Maximum string length: 120
Pattern: ^[^"#$%^*;<>|{}_`~[\]]*$
mcc
string
required

The merchant category code of the Subaccount. See here for more information.

Required string length: 4
Pattern: ^\d{4}$
websiteUrl
string

The website url of the Subaccount

Response

200 - application/json

Returns a new Subaccount

id
string
required
status
enum<string>
required
Available options:
active,
inactive
mcc
string
required
ownerId
any
required
createdAt
any
required
updatedAt
any
required
websiteUrl
string