Skip to main content

ClientBankAccount

A client's account at a bank.

type ClientBankAccount implements Node {
  id: ID!
  accountType: AccountType!
  accountFunction: AccountFunction!
  bankId: BankId!
  name: String!
  accountNumber: String!
  availableBalance: Money!
  currentBalance: Money!
  branchCode: String!
  updatedAt: Date!
}

Fields​

id ● ID! non-null scalar​

accountType ● AccountType! non-null enum​

accountFunction ● AccountFunction! non-null enum​

bankId ● BankId! non-null enum​

name ● String! non-null scalar​

The name of this account. Note that this does not necessarily have semantic significance as many banks allow users to rename their accounts.

accountNumber ● String! non-null scalar​

The account number as displayed in the bank portal.

availableBalance ● Money! non-null scalar​

How much money is estimated to be available after taking pending transactions into account.

currentBalance ● Money! non-null scalar​

How much money is officially available before pending transactions have cleared.

branchCode ● String! non-null scalar​

This field will preferentially use universal branch codes if a given bank supports it.

updatedAt ● Date! non-null scalar​

Time at which the account balances were updated.

Interfaces​

Node interface​

An abstract datatype that has a locally unique identifier, allowing a given node to be later queried by id using the node(id: ID!) query.