API Reference

Accounts

Retrieve account

Account Accounts.Retrieve(AccountRetrieveParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/accounts/{id}

Retrieve account

ParametersExpand Collapse

AccountRetrieveParams parameters

required string id

formatuuid

ReturnsExpand Collapse

class Account:

required string ID

formatuuid

required string AccountNumber

required AccountType AccountType

One of the following:

"checking"Checking

"saving"Saving

required string Balance

required string Currency

required string Environment

required Status Status

One of the following:

"active"Active

"suspended"Suspended

"closed"Closed

required string UserID

formatuuid

string? AdminUserID

formatuuid

DateTimeOffset? CreatedAt

formatdate-time

string? OrganizationID

formatuuid

DateTimeOffset? UpdatedAt

formatdate-time

string? UserRole

Retrieve account

C#

unfold_more

TypeScript

Java

Kotlin

Go

C#

AccountRetrieveParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var account = await client.Accounts.Retrieve(parameters);

Console.WriteLine(account);

200 example

{
  "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

200 example

{
  "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"
}