Accounts

Get an account

get/v1/accounts/{account_id}

Request

Base URL
https://auth-sandbox.fuse.me
Auth
none required
TypeScript
https://skmtc.dev/lorum/apis/auth-api/docs/v1/accounts/:account_id/get.ts
A function with typed inputs. Its response is checked against the schema.

account_idstring uuid required

Account

account_namestring string required

User-friendly account name.

account_ownerstring string required

Name of the account holder. This is the name that will show up on any bank statement.

account_type'primary' | 'payment' | 'virtual' required

available_balanceinteger required

Sum of the immediate available funds in the account. This includes transactions that have not yet been cleared.

currency'AED' | 'USD' | 'JOD' | 'EGP' | 'SAR' | 'GBP' | 'EUR' | 'HKD' | 'CNH' | 'SGD' required

current_balanceinteger required

Sum of all the money in the account.

customer_idstring uuid nullable

external_idstring nullable

User-provided account id.

idstring uuid required

Account id.

status'open' | 'frozen' | 'closed' required

No recorded changes to this operation across all 1 revision of this API.