bankAccounts

Overview

Get all owned bank account information based on login session.

Special Considerations

  • Must make an account before calling this query.
  • PrivateBankStatus may be 'FULLY_VERIFIED' |'PENDING' |'BENEFICIARY_ONLY' | 'FAILED';

Inputs

None.

Returns

Promise<PrivateBankAccount[]>

Returns a promise containing an array of PrivateBankAccount's, where each PrivateBankAccount contains:

PrivateBankAccount: {
    id: ID!,
    accountNumber: string!,
    routingNumber: string!,
    bankName: string!,
    currency: Currency!,
    country: Country!,
    preferredBankAccount: boolean!,
    status: PrivateBankStatus!,
    accountType: string,
    faviconUrl: string,
}

Example

Running this query:

query {
    bankAccounts {
      id
      accountNumber
      routingNumber
      bankName
      currency
      country
      preferredBankAccount
      status
      accountType
      faviconUrl
    }
}

Gives us:

{
  "data": {
    "bankAccounts": [
      {
        "id": "ckbck9a4e006e0726dgvr3kgc",
        "accountNumber": "**1192",
        "routingNumber": "**1192",
        "bankName": "DagBank",
        "currency": "AUD",
        "country": "AU",
        "preferredBankAccount": true,
        "status": "PENDING",
        "accountType": "CHECKING",
        "faviconUrl": "https://yodlee-1.hs.llnwd.net/v1/FAVICON/FAV_8995.PNG"
      }
    ]
  }
}

Common Errors

N/A

← accountscompanyOfficers →