API Reference

Accounts

Accounts

Create account

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

POST/api/v1/accounts

List accounts

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

GET/api/v1/accounts

Retrieve account

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

GET/api/v1/accounts/{id}

Update account status

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

PATCH/api/v1/accounts/{id}

Close account

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

DELETE/api/v1/accounts/{id}

Deposit into account

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

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

Withdraw from account

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

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

Transfer between accounts

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

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

ModelsExpand Collapse

class Account:

id: String

formatuuid

accountNumber: String

accountType: AccountType

One of the following:

CHECKING("checking")

SAVING("saving")

balance: String

currency: String

environment: String

status: Status

One of the following:

ACTIVE("active")

SUSPENDED("suspended")

CLOSED("closed")

userId: String

formatuuid

adminUserId: Optional<String>

formatuuid

createdAt: Optional<LocalDateTime>

formatdate-time

organizationId: Optional<String>

formatuuid

updatedAt: Optional<LocalDateTime>

formatdate-time

userRole: Optional<String>