API Reference

Accounts

Accounts

Create account

client.accounts.create(AccountCreateParams { account_type, user_id, currency, 2 more } body, RequestOptionsoptions?): Account { id, account_number, account_type, 10 more }

POST/api/v1/accounts

List accounts

client.accounts.list(AccountListParams { user_id } query, RequestOptionsoptions?): AccountListResponse { id, account_number, account_type, 10 more }

GET/api/v1/accounts

Retrieve account

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

GET/api/v1/accounts/{id}

Update account status

client.accounts.updateStatus(stringid, AccountUpdateStatusParams { status } body, RequestOptionsoptions?): Account { id, account_number, account_type, 10 more }

PATCH/api/v1/accounts/{id}

Close account

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

DELETE/api/v1/accounts/{id}

Deposit into account

client.accounts.deposit(stringid, AccountDepositParams { amount, description } body, RequestOptionsoptions?): AccountDepositResponse { account, transaction }

POST/api/v1/accounts/{id}/deposit

Withdraw from account

client.accounts.withdraw(stringid, AccountWithdrawParams { amount, description } body, RequestOptionsoptions?): AccountWithdrawResponse { account, transaction }

POST/api/v1/accounts/{id}/withdraw

Transfer between accounts

client.accounts.transfer(stringid, AccountTransferParams { amount, to_account_id, description } body, RequestOptionsoptions?): AccountTransferResponse { from_account, to_account, transaction }

POST/api/v1/accounts/{id}/transfer

ModelsExpand 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

AccountListResponse = Array<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

AccountDepositResponse { account, transaction }

account: 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

transaction: Transaction { id, account_id, amount, 10 more }

id: string

formatuuid

account_id: string

formatuuid

amount: string

balance_after: string

created_at: string

formatdate-time

currency: string

status: "pending" | "completed" | "failed" | "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

transaction_type: "deposit" | "withdrawal" | "transfer" | 2 more

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description?: string | null

external_recipient_id?: string | null

recipient_account_id?: string | null

formatuuid

reference_id?: string | null

formatuuid

AccountWithdrawResponse { account, transaction }

account: 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

transaction: Transaction { id, account_id, amount, 10 more }

id: string

formatuuid

account_id: string

formatuuid

amount: string

balance_after: string

created_at: string

formatdate-time

currency: string

status: "pending" | "completed" | "failed" | "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

transaction_type: "deposit" | "withdrawal" | "transfer" | 2 more

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description?: string | null

external_recipient_id?: string | null

recipient_account_id?: string | null

formatuuid

reference_id?: string | null

formatuuid

AccountTransferResponse { from_account, to_account, transaction }

from_account: 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

to_account: 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

transaction: Transaction { id, account_id, amount, 10 more }

id: string

formatuuid

account_id: string

formatuuid

amount: string

balance_after: string

created_at: string

formatdate-time

currency: string

status: "pending" | "completed" | "failed" | "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

transaction_type: "deposit" | "withdrawal" | "transfer" | 2 more

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description?: string | null

external_recipient_id?: string | null

recipient_account_id?: string | null

formatuuid

reference_id?: string | null

formatuuid