API Reference

Accounts

Accounts

Create account

Account accounts().create(AccountCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v1/accounts

List accounts

List<Account> accounts().list(AccountListParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/accounts

Retrieve account

Account accounts().retrieve(AccountRetrieveParamsparams = AccountRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/api/v1/accounts/{id}

Update account status

Account accounts().updateStatus(AccountUpdateStatusParamsparams = AccountUpdateStatusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

PATCH/api/v1/accounts/{id}

Close account

Account accounts().close(AccountCloseParamsparams = AccountCloseParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/api/v1/accounts/{id}

Deposit into account

AccountDepositResponse accounts().deposit(AccountDepositParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Withdraw from account

AccountWithdrawResponse accounts().withdraw(AccountWithdrawParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

Transfer between accounts

AccountTransferResponse accounts().transfer(AccountTransferParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

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

ModelsExpand Collapse

class Account:

String id

formatuuid

String accountNumber

AccountType accountType

One of the following:

CHECKING("checking")

SAVING("saving")

String balance

String currency

String environment

Status status

One of the following:

ACTIVE("active")

SUSPENDED("suspended")

CLOSED("closed")

String userId

formatuuid

Optional<String> adminUserId

formatuuid

Optional<LocalDateTime> createdAt

formatdate-time

Optional<String> organizationId

formatuuid

Optional<LocalDateTime> updatedAt

formatdate-time

Optional<String> userRole