API Reference

Accounts

Accounts

Create account

Account Accounts.Create(AccountCreateParamsparameters, CancellationTokencancellationToken = default)

POST/api/v1/accounts

List accounts

IReadOnlyList<Account> Accounts.List(AccountListParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/accounts

Retrieve account

Account Accounts.Retrieve(AccountRetrieveParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/accounts/{id}

Update account status

Account Accounts.UpdateStatus(AccountUpdateStatusParamsparameters, CancellationTokencancellationToken = default)

PATCH/api/v1/accounts/{id}

Close account

Account Accounts.Close(AccountCloseParamsparameters, CancellationTokencancellationToken = default)

DELETE/api/v1/accounts/{id}

Deposit into account

AccountDepositResponse Accounts.Deposit(AccountDepositParamsparameters, CancellationTokencancellationToken = default)

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

Withdraw from account

AccountWithdrawResponse Accounts.Withdraw(AccountWithdrawParamsparameters, CancellationTokencancellationToken = default)

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

Transfer between accounts

AccountTransferResponse Accounts.Transfer(AccountTransferParamsparameters, CancellationTokencancellationToken = default)

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

ModelsExpand 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