Skip to main content
GET
/
v1
/
accounts
/
{account_id}
Get Account
curl --request GET \
  --url https://api.example.com/v1/accounts/{account_id}
{
  "accountId": "<string>",
  "name": "<string>",
  "purpose": "OPERATING",
  "classification": "PRIMARY",
  "status": "ACTIVE",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {}
}

Path Parameters

​
account_id
string
required

The unique identifier of the account to update, starts with acct_

Response

The request has succeeded.

Represents a financial account in the system Accounts are used to track balances and process transactions

​
accountId
string
required

Unique identifier for the account

​
name
string
required

Display name for the account

​
purpose
enum<string>
required

The purpose of the account

Available options:
OPERATING,
WALLET,
REVENUE,
TAX,
RESERVE,
OTHER
​
classification
enum<string>
required

Classification that determines the account's priority and usage patterns

Available options:
PRIMARY,
SECONDARY
​
status
enum<string>
required

Current operational status of the account

Available options:
ACTIVE,
INACTIVE
​
updatedAt
string<date-time>
required

Timestamp when the account was created

​
createdAt
string<date-time>
required

Timestamp when the account was last updated

​
description
string

Detailed description of the account's purpose

​
metadata
object

Additional custom data associated with the account