Bank Accounts

The BankAccount Object

Properties

idstring

The Rutter generated unique ID of the bank account.

platform_idstring

The platform specific ID of the bank account.

maskstringnullable

The mask of the bank account

namestringnullable

The name of the bank account

subtypeenumnullable

The subtype of the bank account

One of401_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, or null.
typeenumnullable

The type of the bank account

One ofannuity, credit, depository, insurance, investment, loan, property, other, or null.
balanceobjectnullable
Show balance attributes
last_synced_atstring

The ISO 8601 timestamp when the bank account was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/banking/bank_accounts
GET
/banking/bank_accounts/:id
GET
/banking/bank_accounts/:id/details
GET
/banking/bank_accounts/:id/balance

List Bank Accounts

GEThttps://production.rutterapi.com/versioned/banking/bank_accounts

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Currently supports the updated_at and last_synced_at fields.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_accounts": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "mask": "123456",


7
      "name": "Bank Account Name",


8
      "subtype": "checking",


9
      "type": "depository",


10
      "balance": {


11
        "available": 100,


12
        "currency_code": "USD",


13
        "current": 100


14
      },


15
      "last_synced_at": "2023-01-02T02:34:56.000Z",


16
      "platform_data": {


17
        "id": 123,


18
        "data": "Varies by platform"


19
      }


20
    }


21
  ],


22
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


23
  "connection": {


24
    "id": "00000000-0000-0000-0000-000000000000",


25
    "orgId": "00000000-0000-0000-0000-000000000000",


26
    "platform": "NETSUITE"


27
  }


28
}

Fetch a Bank Account

GEThttps://production.rutterapi.com/versioned/banking/bank_accounts/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_account": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "mask": "123456",


6
    "name": "Bank Account Name",


7
    "subtype": "checking",


8
    "type": "depository",


9
    "balance": {


10
      "available": 100,


11
      "currency_code": "USD",


12
      "current": 100


13
    },


14
    "last_synced_at": "2023-01-02T02:34:56.000Z",


15
    "platform_data": {


16
      "id": 123,


17
      "data": "Varies by platform"


18
    }


19
  },


20
  "connection": {


21
    "id": "00000000-0000-0000-0000-000000000000",


22
    "orgId": "00000000-0000-0000-0000-000000000000",


23
    "platform": "NETSUITE"


24
  }


25
}

Fetch Bank Account Details

GEThttps://production.rutterapi.com/versioned/banking/bank_accounts/:id/details

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_account_details": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "ach": {


6
      "account_number": "123456789",


7
      "routing_number": "123456789",


8
      "wire_routing_number": "123456789"


9
    },


10
    "last_synced_at": "2023-01-02T02:34:56.000Z",


11
    "platform_data": {


12
      "id": 123,


13
      "data": "Varies by platform"


14
    }


15
  },


16
  "connection": {


17
    "id": "00000000-0000-0000-0000-000000000000",


18
    "orgId": "00000000-0000-0000-0000-000000000000",


19
    "platform": "NETSUITE"


20
  }


21
}

Fetch Bank Account Balance

GEThttps://production.rutterapi.com/versioned/banking/bank_accounts/:id/balance

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

200
Example Response Body
JSON
1
{


2
  "bank_account_balance": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "account_id": "00000000-0000-0000-0000-000000000000",


6
    "available": 100,


7
    "currency_code": "USD",


8
    "current": 100,


9
    "last_synced_at": "2023-01-02T02:34:56.000Z",


10
    "platform_data": {


11
      "id": 123,


12
      "data": "Varies by platform"


13
    }


14
  },


15
  "connection": {


16
    "id": "00000000-0000-0000-0000-000000000000",


17
    "orgId": "00000000-0000-0000-0000-000000000000",


18
    "platform": "NETSUITE"


19
  }


20
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Bank Transactions