Create a Subaccount

Create a Subaccount which can be used to reconcile orders, refunds and payouts more easily.

POST /api/service/subaccount/create

JavaScript

JavaScript

import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const subaccount = await client.subaccounts.create({ legalName: 'legalName', mcc: '7321' });

console.log(subaccount.id);

200

{
  "id": "<string>",
  "legalName": "<string>",
  "mcc": "<string>",
  "ownerId": "<unknown>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "websiteUrl": "<string>"
}

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

legalName · string · required

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

legalName · string · required

status · enum<string> · required

Available options: active, inactive

mcc · string · required

ownerId · any · required

createdAt · any · required

updatedAt · any · required

websiteUrl · string