CHcheckhq

List bank accounts

Changed on

Lists all bank accounts.

get/bank_accounts

Request

Query parameters

companystring

Return bank accounts for this company ID.

employeestring

Return bank accounts for these employee IDs. You can specify multiple employee IDs by repeating this parameter: ?employee=emp_abc123&employee=emp_xyz789.

contractorstring

Return bank accounts for this contractor ID.

limitinteger

Number of bank accounts returned per page. The maximum value is 500.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

metadataobject

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

200

idstring
employeestring
metadataobject

Example response

[
  {
    "id": "bnk_abc",
    "employee": "emp_xyz",
    "raw_bank_account": {
      "institution_name": "Chase",
      "account_number": "112233445",
      "routing_number": "011401533",
      "subtype": "checking"
    }
  }
]

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter metadata