Retrieve an account
Retrieve an Account and its user-facing balance components. Components are omitted when the credential cannot view balances.
Authorizations
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.
^le_[a-zA-Z0-9]+$Path Parameters
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.
Account id with the sa_group_ prefix.
"sa_group_primary123"
Display name.
"Slash Platinum"
Financial product represented by this Account.
checking, secured_charge_card, unsecured_charge_card, business_debit, global_usd open, locked, pending_close, closed ^[A-Z]{3}$"USD"
Account number presented to the customer, when applicable.
Routing number presented to the customer, when applicable.
User-facing balance breakdown. Returned by account retrieval when the credential can view balances.
- Transactional
- Collateral
- Credit
- Global USD