Skip to main content
POST
/
api
/
service
/
subaccount
/
retrieve
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.retrieve({ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(subaccount.id);
{
  "id": "<string>",
  "legalName": "<string>",
  "status": "active",
  "mcc": "<string>",
  "ownerId": "<unknown>",
  "createdAt": "<unknown>",
  "updatedAt": "<unknown>",
  "websiteUrl": "<string>"
}

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
id
string<uuid>
required

The unique identifier of the Subaccount

Response

200 - application/json

Returns a 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