Retrieve an account

Changed on

Retrieve an Account and its user-facing balance components. Components are omitted when the credential cannot view balances.

get/v2/accounts/{accountId}

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/accounts/{accountId}
  • Auth
    API key in header X-API-Key

Response

The requested Account.

idstring required

Account id with the sa_group_ prefix.

namestring required

Display name.

type'checking' | 'secured_charge_card' | 'unsecured_charge_card' | 'business_debit' | 'global_usd' required

Financial product represented by this Account.

status'open' | 'locked' | 'pending_close' | 'closed' required
currencystring required
accountNumberstring

Account number presented to the customer, when applicable.

routingNumberstring

Routing number presented to the customer, when applicable.

createdAtstring date-time required

Example response

{
  "id": "sa_group_primary123",
  "name": "Slash Platinum",
  "currency": "USD"
}

Changes