Retrieve account

client.accounts.retrieve(, ?): Account { id, account_number, account_type, 10 more }

GET/api/v1/accounts/{id}

Retrieve account

ParametersExpand Collapse

id: string

formatuuid

ReturnsExpand Collapse

Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" | "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" | "suspended" | "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id?: string | null

formatuuid

created_at?: string | null

formatdate-time

organization_id?: string | null

formatuuid

updated_at?: string | null

formatdate-time

user_role?: string | null

Retrieve account

import Rails from 'railsinfra';

const client = new Rails({
  apiKey: process.env['RAILS_API_KEY'], // This is the default and can be omitted
});

const account = await client.accounts.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(account.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_number": "account_number",
  "account_type": "checking",
  "balance": "balance",
  "currency": "currency",
  "environment": "environment",
  "status": "active",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user_role": "user_role"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_number": "account_number",
  "account_type": "checking",
  "balance": "balance",
  "currency": "currency",
  "environment": "environment",
  "status": "active",
  "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "user_role": "user_role"
}