Skip to main content

BankAccount

A user's account at a bank.

This type requires the following scope:

[accounts]

type BankAccount implements Node {
  id: ID!
  accountType: AccountType!
  name: String!
  availableBalance: Money
  currentBalance: Money
  accountHolder: AccountHolder
  accountNumber: String!
  accountNumber_PCI_UNSAFE: String
  branchCode: String
  bankId: BankId!
  currency: CurrencyCode!
  debitOrderPayments(
    first: UInt
    after: Cursor
    filter: DebitOrderPaymentFilterInput
  ): DebitOrderPaymentConnection
  debiCheckMandates(
    first: UInt
    after: Cursor
    filter: DebiCheckMandateFilterInput
  ): DebiCheckMandateConnection
  transactions(
    first: UInt
    after: Cursor
    filter: TransactionFilterInput
  ): TransactionConnection
  statements(
    first: UInt
    after: Cursor
    filter: BankAccountStatementFilterInput
  ): BankAccountStatementConnection
  pendingTransactions(
    first: UInt
    after: Cursor
    filter: PendingTransactionFilterInput
  ): PendingTransactionConnection
  user: User!
  supportsPaymentInitiation: Boolean
}

Fields​

id ● ID! non-null scalar​

accountType ● AccountType! 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.

availableBalance ● Money scalar​

How much money is actually available to spend, usually smaller than the currentBalance

This field requires the following scope:

[balances]

currentBalance ● Money scalar​

How much money is officially available before pending transactions have cleared. Usually larger than availableBalance

This field requires the following scope:

[balances]

accountHolder ● AccountHolder union​

The details of the entity that owns the account. This is nullable because we only expect this to exist for at least one of a users accounts, depending on the bank.

accountNumber ● String! non-null scalar​

The account number as displayed in the bank portal. Note that for credit cards, the account number will usually be masked.

accountNumber_PCI_UNSAFE ● String scalar​

The unmasked account number, if one is available, of a bank account.

Some banks mask the true account number for bank accounts. In cases where the bank does not mask account numbers, Stitch will mask those account numbers by default.

In the unlikely event that you find that you absolutely need an unmasked account number, you may query this field.

Querying this field puts you in scope for PCI DSS. Please see https://www.pcisecuritystandards.org/pci_security/ for more info.

Note that some banks mask account numbers, in those cases this field will still return the masked value.

This field requires the following scope:

[pci_unsafe]

branchCode ● String scalar​

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

bankId ● BankId! non-null enum​

currency ● CurrencyCode! non-null scalar​

debitOrderPayments ● DebitOrderPaymentConnection object​

DebitOrderPayments are ordered in reverse chronological order.

By default this field returns the bank's default number of visible debit order payments on a single page.

first ● UInt scalar​

Specifies the maximum number of results to return

after ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

filter ● DebitOrderPaymentFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

debiCheckMandates ● DebiCheckMandateConnection object​

first ● UInt scalar​
after ● Cursor scalar​
filter ● DebiCheckMandateFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

transactions ● TransactionConnection object​

Transactions are ordered in reverse chronological order.

By default this field returns the bank's default number of visible transactions.

first ● UInt scalar​

Specifies the maximum number of results to return

after ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

filter ● TransactionFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

statements ● BankAccountStatementConnection object​

Returns a list of available bank statements

first ● UInt scalar​

Specifies the maximum number of results to return

after ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

filter ● BankAccountStatementFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

pendingTransactions ● PendingTransactionConnection object​

An approved transaction that has not been fully processed yet. Commonly, a Card transaction that has been approved, but the funds have not yet moved.

PendingTransactions are ordered in reverse chronological order.

By default this field returns the bank's default number of visible pending transactions.

first ● UInt scalar​

Specifies the maximum number of results to return

after ● Cursor scalar​

Takes in the paging cursor. The next page of results will start after this cursor

filter ● PendingTransactionFilterInput input​

ALPHA feature, please do not rely on this argument for production usage.

user ● User! non-null object​

The user attached to this account.

supportsPaymentInitiation ● Boolean scalar​

Whether this account can make payments or not

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.