API Reference

Accounts

Accounts

Create account

client.Accounts.New(ctx, body) (*Account, error)

POST/api/v1/accounts

List accounts

client.Accounts.List(ctx, query) (*[]Account, error)

GET/api/v1/accounts

Retrieve account

client.Accounts.Get(ctx, id) (*Account, error)

GET/api/v1/accounts/{id}

Update account status

client.Accounts.UpdateStatus(ctx, id, body) (*Account, error)

PATCH/api/v1/accounts/{id}

Close account

client.Accounts.Close(ctx, id) (*Account, error)

DELETE/api/v1/accounts/{id}

Deposit into account

client.Accounts.Deposit(ctx, id, body) (*AccountDepositResponse, error)

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

Withdraw from account

client.Accounts.Withdraw(ctx, id, body) (*AccountWithdrawResponse, error)

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

Transfer between accounts

client.Accounts.Transfer(ctx, id, body) (*AccountTransferResponse, error)

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

ModelsExpand Collapse

type Account struct{…}

ID string

formatuuid

AccountNumber string

AccountType AccountAccountType

One of the following:

const AccountAccountTypeChecking AccountAccountType = "checking"

const AccountAccountTypeSaving AccountAccountType = "saving"

Balance string

Currency string

Environment string

Status AccountStatus

One of the following:

const AccountStatusActive AccountStatus = "active"

const AccountStatusSuspended AccountStatus = "suspended"

const AccountStatusClosed AccountStatus = "closed"

UserID string

formatuuid

AdminUserID stringOptional

formatuuid

CreatedAt TimeOptional

formatdate-time

OrganizationID stringOptional

formatuuid

UpdatedAt TimeOptional

formatdate-time

UserRole stringOptional