Accounts

List Bank Accounts

Returns a list of bank accounts. An API key restricted to one account sees only that account.

get/accounts

Request

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

Example response

{
  "page": {
    "nextOffset": "qwer123454q2f"
  },
  "accounts": [
    {
      "depositAccount": {
        "accountId": "cash_account_12345678-1234-1234-1234-123456789012",
        "accountNumberDisplay": "5820",
        "accountType": "CHECKING",
        "bankProductType": "Grasshopper Bank N.A.; Member FDIC",
        "currency": {
          "currencyCode": "USD"
        },
        "nickname": "Main Checking",
        "productName": "Business Checking",
        "status": "OPEN"
      }
    },
    {
      "investmentAccount": {
        "accountId": "brokerage_account_12345678-1234-1234-1234-123456789012",
        "accountNumberDisplay": "8200",
        "accountType": "TAXABLE",
        "currency": {
          "currencyCode": "USD"
        },
        "nickname": "Treasury Account",
        "productName": "Treasury",
        "status": "OPEN"
      }
    }
  ]
}

Changes

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