Skip to main content
GET
Retrieve an account

Authorizations

X-API-Key
string
header
required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

accountId
string
required

Account id with the sa_group_ prefix.

Response

The requested Account.

A Slash financial product and its user-facing balances. An Account can contain a primary virtual account and additional virtual accounts. API v2 exposes eligible banking products and Global USD; savings, acquiring, and legacy treasury products are omitted. Global USD is readable but cannot source an API v2 transfer.

id
string
required

Account id with the sa_group_ prefix.

Example:

"sa_group_primary123"

name
string
required

Display name.

Example:

"Slash Platinum"

type
enum<string>
required

Financial product represented by this Account.

Available options:
checking,
secured_charge_card,
unsecured_charge_card,
business_debit,
global_usd
status
enum<string>
required
Available options:
open,
locked,
pending_close,
closed
currency
string
required
Pattern: ^[A-Z]{3}$
Example:

"USD"

createdAt
string<date-time>
required
accountNumber
string

Account number presented to the customer, when applicable.

routingNumber
string

Routing number presented to the customer, when applicable.

balanceComponents
(Transactional · object | Collateral · object | Credit · object | Global USD · object)[]

User-facing balance breakdown. Returned by account retrieval when the credential can view balances.