API Reference

Accounts

Accounts

Create account

POST/api/v1/accounts

List accounts

GET/api/v1/accounts

Retrieve account

GET/api/v1/accounts/{id}

Update account status

PATCH/api/v1/accounts/{id}

Close account

DELETE/api/v1/accounts/{id}

Deposit into account

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

Withdraw from account

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

Transfer between accounts

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

ModelsExpand Collapse

Account object { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

AccountListResponse = array of Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

AccountDepositResponse object { account, transaction }

account: Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

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" or "completed" or "failed" or "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

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

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description: optional string

external_recipient_id: optional string

recipient_account_id: optional string

formatuuid

reference_id: optional string

formatuuid

AccountWithdrawResponse object { account, transaction }

account: Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

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" or "completed" or "failed" or "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

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

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description: optional string

external_recipient_id: optional string

recipient_account_id: optional string

formatuuid

reference_id: optional string

formatuuid

AccountTransferResponse object { from_account, to_account, transaction }

from_account: Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

to_account: Account { id, account_number, account_type, 10 more }

id: string

formatuuid

account_number: string

account_type: "checking" or "saving"

One of the following:

"checking"

"saving"

balance: string

currency: string

environment: string

status: "active" or "suspended" or "closed"

One of the following:

"active"

"suspended"

"closed"

user_id: string

formatuuid

admin_user_id: optional string

formatuuid

created_at: optional string

formatdate-time

organization_id: optional string

formatuuid

updated_at: optional string

formatdate-time

user_role: optional string

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" or "completed" or "failed" or "cancelled"

One of the following:

"pending"

"completed"

"failed"

"cancelled"

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

One of the following:

"deposit"

"withdrawal"

"transfer"

"recurring_payment"

"savings_withdraw"

updated_at: string

formatdate-time

description: optional string

external_recipient_id: optional string

recipient_account_id: optional string

formatuuid

reference_id: optional string

formatuuid