Rutter · Schema

ListBankAccountResponseWithConnection

AccountingB2BCommerceFinancial DataPaymentsUnified APIHRIS

Properties

Name Type Description
bank_accounts array
next_cursor stringnull
connection object
View JSON Schema on GitHub

JSON Schema

rutter-list-bank-account-response-with-connection-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rutter/json-schema/rutter-list-bank-account-response-with-connection-schema.json",
  "title": "ListBankAccountResponseWithConnection",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rutter-banking-api-openapi.yml#/components/schemas/ListBankAccountResponseWithConnection",
  "type": "object",
  "properties": {
    "bank_accounts": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BankAccount"
      }
    },
    "next_cursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "connection": {
      "$ref": "#/$defs/Connection"
    }
  },
  "required": [
    "bank_accounts",
    "connection"
  ],
  "$defs": {
    "BankAccount": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The Rutter generated unique ID of the bank account.",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "platform_id": {
          "type": "string",
          "description": "The platform specific ID of the bank account.",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "mask": {
          "type": [
            "string",
            "null"
          ],
          "description": "The mask of the bank account",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {}
          }
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the bank account",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "subtype": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "401_a",
            "401_k",
            "403_b",
            "409_a",
            "457",
            "457_b",
            "529",
            "accidental_death_and_dismemberment",
            "advisory_account",
            "appliances",
            "art",
            "auto",
            "boat",
            "bonds",
            "brokerage",
            "brokerage_margin",
            "business",
            "business_checking_or_savings",
            "business_savings",
            "cash_isa",
            "cash_management",
            "cash_management_account",
            "certificate_of_deposit",
            "charge",
            "charitable_gift_account",
            "checking",
            "checking_or_savings",
            "church_account",
            "commercial",
            "commercial_line_of_credit",
            "computer",
            "conservatorship",
            "construction",
            "consumer",
            "corporate_account",
            "coverdell",
            "credit_card",
            "crypto_exchange",
            "custodial",
            "debit_card",
            "defined_benefit_plan",
            "defined_contribution_plan",
            "disability",
            "ebt",
            "education_saving_account",
            "educational",
            "electronics",
            "employee_stock_ownership_plan",
            "employee_stock_purchase_plan",
            "escrow",
            "estate",
            "executor",
            "fixed_annuity",
            "fixed_annuity_roth_ira",
            "fixed_annuity_traditional_ira",
            "foreign",
            "funds",
            "furniture",
            "gic",
            "group_retirement_savings_plan",
            "guardian",
            "guaranteed_investment_certificate",
            "health",
            "health_reimbursement_arrangement",
            "heloc",
            "home_equity",
            "home_line_of_credit",
            "hra",
            "hsa",
            "indexed_annuity",
            "individual",
            "inherited_annuity",
            "inherited_roth_ira",
            "inherited_traditional_ira",
            "installment",
            "institutional_trust",
            "investment_club",
            "ira",
            "irrevocable_trust",
            "isa",
            "jewelry",
            "joint_tenants_by_entirety",
            "joint_tenants_community_property",
            "joint_tenants_in_common",
            "joint_tenants_with_rights_of_survivorship",
            "keogh",
            "keough_plan",
            "lif",
            "life_insurance",
            "life_income_fund",
            "limited_liability_account",
            "line_of_credit",
            "lira",
            "living_trust",
            "loan",
            "locked_in_retirement_account",
            "locked_in_retirement_investment_fund",
            "locked_in_retirement_savings_account",
            "long_term_care",
            "lrif",
            "lrsp",
            "military",
            "miscellaneous",
            "money_market",
            "money_purchase_plan",
            "mortgage",
            "mutual_fund",
            "non_custodial_wallet",
            "non_taxable",
            "non_taxable_brokerage_account",
            "other_annuity",
            "other_insurance",
            "overdraft",
            "partnership",
            "paypal",
            "pension",
            "personal",
            "personal_with_collateral",
            "powersports",
            "prepaid",
            "prif",
            "profit_sharing_plan",
            "property_and_casualty",
            "qshr",
            "rdsp",
            "real_estate",
            "registered_disability_savings_plan",
            "registered_education_savings_plan",
            "registered_locked_in_savings_plan",
            "registered_pension_plan",
            "registered_retirement_income_fund",
            "registered_retirement_savings_plan",
            "resp",
            "retirement",
            "revocable_trust",
            "revolving",
            "rlif",
            "rollover_ira",
            "roth",
            "roth_401_k",
            "roth_conversion",
            "roth_ira",
            "rpp",
            "rrif",
            "rrsp",
            "rv",
            "sarsep",
            "sarsep_ira",
            "savings",
            "securities",
            "sep_ira",
            "sepp_ira",
            "simple_ira",
            "simplified_employee_pension",
            "sipp",
            "small_business",
            "sole_proprietorship",
            "sports_equipment",
            "spousal_ira",
            "spousal_roth_ira",
            "stock_plan",
            "stocks",
            "student",
            "sweep",
            "tax_free_savings_account",
            "taxable",
            "term_life",
            "testamentary_trust",
            "tfsa",
            "thrift_savings_plan",
            "time_deposit",
            "trade_ira",
            "treasury",
            "trust",
            "ugma",
            "uniform_gifts_to_minors_act",
            "uniform_transfer_to_minors_act",
            "universal_life",
            "utma",
            "variable_annuity",
            "variable_annuity_roth_ira",
            "variable_annuity_traditional_ira",
            "variable_universal_life",
            "vehicle",
            "vehicle_insurance",
            "whole_life",
            "other",
            "null"
          ],
          "description": "The subtype of the bank account",
          "x-rutter-platforms": {
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "annuity",
            "credit",
            "depository",
            "insurance",
            "investment",
            "loan",
            "property",
            "other",
            "null"
          ],
          "description": "The type of the bank account",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "balance": {
          "type": [
            "object",
            "null"
          ],
          "properties": {
            "available": {
              "type": [
                "number",
                "null"
              ],
              "description": "The available balance in the account",
              "x-rutter-platforms": {
                "MX": {},
                "PLAID": {},
                "RAMP": {},
                "TELLER": {}
              }
            },
            "currency_code": {
              "type": [
                "string",
                "null"
              ],
              "enum": [
                "AED",
                "AFN",
                "ALL",
                "AMD",
                "ANG",
                "AOA",
                "ARS",
                "AUD",
                "AWG",
                "AZN",
                "BAM",
                "BBD",
                "BDT",
                "BGN",
                "BHD",
                "BIF",
                "BMD",
                "BND",
                "BOB",
                "BOV",
                "BRL",
                "BSD",
                "BTN",
                "BWP",
                "BYR",
                "BZD",
                "CAD",
                "CDF",
                "CHE",
                "CHF",
                "CHW",
                "CLF",
                "CLP",
                "CNY",
                "COP",
                "COU",
                "CRC",
                "CUC",
                "CUP",
                "CVE",
                "CZK",
                "DJF",
                "DKK",
                "DOP",
                "DZD",
                "EGP",
                "ERN",
                "ETB",
                "EUR",
                "FJD",
                "FKP",
                "GBP",
                "GEL",
                "GHS",
                "GIP",
                "GMD",
                "GNF",
                "GTQ",
                "GYD",
                "HKD",
                "HNL",
                "HRK",
                "HTG",
                "HUF",
                "IDR",
                "ILS",
                "INR",
                "IQD",
                "IRR",
                "ISK",
                "JMD",
                "JOD",
                "JPY",
                "KES",
                "KGS",
                "KHR",
                "KMF",
                "KPW",
                "KRW",
                "KWD",
                "KYD",
                "KZT",
                "LAK",
                "LBP",
                "LKR",
                "LRD",
                "LSL",
                "LTL",
                "LVL",
                "LYD",
                "MAD",
                "MDL",
                "MGA",
                "MKD",
                "MMK",
                "MNT",
                "MOP",
                "MRO",
                "MUR",
                "MVR",
                "MWK",
                "MXN",
                "MXV",
                "MYR",
                "MZN",
                "NAD",
                "NGN",
                "NIO",
                "NOK",
                "NPR",
                "NZD",
                "OMR",
                "PAB",
                "PEN",
                "PGK",
                "PHP",
                "PKR",
                "PLN",
                "PYG",
                "QAR",
                "RON",
                "RSD",
                "RUB",
                "RWF",
                "SAR",
                "SBD",
                "SCR",
                "SDG",
                "SEK",
                "SGD",
                "SHP",
                "SLL",
                "SOS",
                "SRD",
                "SSP",
                "STD",
                "SVC",
                "SYP",
                "SZL",
                "THB",
                "TJS",
                "TMT",
                "TND",
                "TOP",
                "TRY",
                "TTD",
                "TWD",
                "TZS",
                "UAH",
                "UGX",
                "USD",
                "USN",
                "USS",
                "UYI",
                "UYU",
                "UYW",
                "UZS",
                "VEF",
                "VND",
                "VUV",
                "WST",
                "XAF",
                "XAG",
                "XAU",
                "XBA",
                "XBB",
                "XBC",
                "XBD",
                "XCD",
                "XDR",
                "XFU",
                "XOF",
                "XPD",
                "XPF",
                "XPT",
                "XTS",
                "XXX",
                "YER",
                "ZAR",
                "ZMW",
                "ETH",
                "BTC",
                "null"
              ],
              "description": "The currency code of the balance",
              "x-rutter-platforms": {
                "PLAID": {},
                "RAMP": {},
                "TELLER": {}
              }
            },
            "current": {
              "type": [
                "number",
                "null"
              ],
              "description": "The current balance in the account",
              "x-rutter-platforms": {
                "MX": {},
                "PLAID": {},
                "RAMP": {},
                "TELLER": {}
              }
            }
          },
          "required": [
            "available",
            "currency_code",
            "current"
          ],
          "additionalProperties": false,
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "last_synced_at": {
          "type": "string",
          "description": "The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp when the bank account was last synced by Rutter.",
          "x-rutter-platforms": {
            "MX": {},
            "PLAID": {},
            "RAMP": {},
            "TELLER": {}
          }
        },
        "platform_data": {
          "type": "object",
          "additionalProperties": {},
          "description": "The raw platform data corresponding to the Rutter object."
        }
      },
      "required": [
        "id",
        "platform_id",
        "mask",
        "name",
        "subtype",
        "type",
        "balance",
        "last_synced_at"
      ]
    },
    "Connection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The UUID of the connection. Generated by Rutter."
        },
        "orgId": {
          "type": "string",
          "format": "uuid",
          "description": "Your organization id."
        },
        "platform": {
          "$ref": "#/$defs/Platform"
        }
      },
      "required": [
        "id",
        "orgId",
        "platform"
      ]
    },
    "Platform": {
      "type": "string",
      "enum": [
        "AMAZON",
        "EBAY",
        "ETSY",
        "FNAC",
        "WALMART",
        "SHOPEE",
        "LAZADA",
        "MERCADOLIBRE",
        "ALIBABA",
        "WAYFAIR",
        "SHEIN",
        "NOON",
        "SHOPLINE",
        "PRESTASHOP",
        "SHOPIFY",
        "MAGENTO",
        "WOO_COMMERCE",
        "SQUARESPACE",
        "WIX",
        "SHOPER",
        "SHOPLAZZA",
        "BIG_COMMERCE",
        "SALLA",
        "ZID",
        "TIKTOKSHOP",
        "COMMERCELAYER",
        "WEBFLOW",
        "GUMROAD",
        "ECWID",
        "PAYPAL",
        "SQUARE",
        "STRIPE",
        "CLOVER",
        "MOLLIE",
        "PAYNL",
        "AUTHORIZENET",
        "RECHARGE",
        "CHARGIFY",
        "CHARGEBEE",
        "RECURLY",
        "KASHFLOW",
        "SAGE_INTACCT",
        "SAGE_INTACCT_V2",
        "DYNAMICS365",
        "DYNAMICS365FO",
        "ZOHOBOOKS",
        "EXACTONLINE",
        "FREEAGENT",
        "QUICKBOOKS",
        "QUICKBOOKS_DESKTOP",
        "FRESHBOOKS",
        "XERO",
        "SAGE_BUSINESS_CLOUD",
        "SAGE_50",
        "VISTA",
        "NETSUITE",
        "WAVE",
        "DUALENTRY",
        "CAMPFIRE",
        "RILLET",
        "SOFTLEDGER",
        "VISMA",
        "SPIRIS",
        "LEXWARE",
        "MONEYBIRD",
        "SAGE200CLOUD",
        "MX",
        "PLAID",
        "TELLER",
        "RAMP",
        "ODOO",
        "ACUMATICA",
        "FULFIL",
        "TALLY",
        "SAPBUSINESSONE",
        "SAPS4HANA",
        "WORKDAY",
        "ANFIX",
        "ORACLEFUSION",
        "HOLDED",
        "MYOBBUSINESS",
        "FORTNOX",
        "GOOGLE",
        "FACEBOOK",
        "TIKTOK",
        "INTUIT_BANK_FEEDS",
        "PLAID_BANK_FEEDS",
        "SAGE",
        "SAGE_BANK_FEEDS",
        "YODLEE_BANK_FEEDS",
        "QUICKBOOKS_HRIS",
        "BAMBOO_HR",
        "GUSTO",
        "DEEL",
        "RIPPLING"
      ],
      "description": "The underlying platform."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rutter-list-bank-account-response-with-connection"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.