> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /bank-feed-accounts GET https://api.merge.dev/api/accounting/v1/bank-feed-accounts Returns a list of `BankFeedAccount` objects. Reference: https://docs.merge.dev/merge-unified/accounting/common-models/bank-feed-accounts/list ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Query parameters - `cursor` (string, optional) — The pagination cursor value. - `include_deleted_data` (boolean, optional) — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `page_size` (integer, optional) — Number of results to return per page. The maximum limit is 100. ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `next` (string, optional, nullable) - `previous` (string, optional, nullable) - `results` (list of BankFeedAccount, optional) ## Types ### BankFeedAccount # The BankFeedAccount Object ### Description The `BankFeedAccount` object represents a bank feed account, detailing various attributes including account identifiers, names, currency, and balance information. This object is central to managing and tracking bank feed accounts within the system. ### Usage Example Fetch from the `GET BankFeedAccount` endpoint to view details of a bank feed account. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `source_account_id` (string, optional, nullable) — The unique identifier of the source account from our customer’s platform. - `target_account_id` (string, optional, nullable) — The unique identifier of the target account from the third party software. - `source_account_name` (string, optional, nullable) — The name of the source account as stored in our customer’s platform. - `source_account_number` (string, optional, nullable) — The human-readable account number of the source account as stored in our customer’s platform. - `target_account_name` (string, optional, nullable) — The name of the target account from the third party software. - `currency` (enum, optional, nullable) — The currency code of the bank feed. The currency code in ISO 4217 format. - Allowed values: `XUA`, `AFN`, `AFA`, `ALL`, `ALK`, `DZD`, `ADP`, `AOA`, `AOK`, `AON`, `AOR`, `ARA`, `ARS`, `ARM`, `ARP`, `ARL`, `AMD`, `AWG`, `AUD`, `ATS`, `AZN`, `AZM`, `BSD`, `BHD`, `BDT`, `BBD`, `BYN`, `BYB`, `BYR`, `BEF`, `BEC`, `BEL`, `BZD`, `BMD`, `BTN`, `BOB`, `BOL`, `BOV`, `BOP`, `BAM`, `BAD`, `BAN`, `BWP`, `BRC`, `BRZ`, `BRE`, `BRR`, `BRN`, `BRB`, `BRL`, `GBP`, `BND`, `BGL`, `BGN`, `BGO`, `BGM`, `BUK`, `BIF`, `XPF`, `KHR`, `CAD`, `CVE`, `KYD`, `XAF`, `CLE`, `CLP`, `CLF`, `CNX`, `CNY`, `CNH`, `COP`, `COU`, `KMF`, `CDF`, `CRC`, `HRD`, `HRK`, `CUC`, `CUP`, `CYP`, `CZK`, `CSK`, `DKK`, `DJF`, `DOP`, `NLG`, `XCD`, `DDM`, `ECS`, `ECV`, `EGP`, `GQE`, `ERN`, `EEK`, `ETB`, `EUR`, `XBA`, `XEU`, `XBB`, `XBC`, `XBD`, `FKP`, `FJD`, `FIM`, `FRF`, `XFO`, `XFU`, `GMD`, `GEK`, `GEL`, `DEM`, `GHS`, `GHC`, `GIP`, `XAU`, `GRD`, `GTQ`, `GWP`, `GNF`, `GNS`, `GYD`, `HTG`, `HNL`, `HKD`, `HUF`, `IMP`, `ISK`, `ISJ`, `INR`, `IDR`, `IRR`, `IQD`, `IEP`, `ILS`, `ILP`, `ILR`, `ITL`, `JMD`, `JPY`, `JOD`, `KZT`, `KES`, `KWD`, `KGS`, `LAK`, `LVL`, `LVR`, `LBP`, `LSL`, `LRD`, `LYD`, `LTL`, `LTT`, `LUL`, `LUC`, `LUF`, `MOP`, `MKD`, `MKN`, `MGA`, `MGF`, `MWK`, `MYR`, `MVR`, `MVP`, `MLF`, `MTL`, `MTP`, `MRU`, `MRO`, `MUR`, `MXV`, `MXN`, `MXP`, `MDC`, `MDL`, `MCF`, `MNT`, `MAD`, `MAF`, `MZE`, `MZN`, `MZM`, `MMK`, `NAD`, `NPR`, `ANG`, `TWD`, `NZD`, `NIO`, `NIC`, `NGN`, `KPW`, `NOK`, `OMR`, `PKR`, `XPD`, `PAB`, `PGK`, `PYG`, `PEI`, `PEN`, `PES`, `PHP`, `XPT`, `PLN`, `PLZ`, `PTE`, `GWE`, `QAR`, `XRE`, `RHD`, `RON`, `ROL`, `RUB`, `RUR`, `RWF`, `SVC`, `WST`, `SAR`, `RSD`, `CSD`, `SCR`, `SLL`, `XAG`, `SGD`, `SKK`, `SIT`, `SBD`, `SOS`, `ZAR`, `ZAL`, `KRH`, `KRW`, `KRO`, `SSP`, `SUR`, `ESP`, `ESA`, `ESB`, `XDR`, `LKR`, `SHP`, `XSU`, `SDD`, `SDG`, `SDP`, `SRD`, `SRG`, `SZL`, `SEK`, `CHF`, `SYP`, `STN`, `STD`, `TVD`, `TJR`, `TJS`, `TZS`, `XTS`, `THB`, `XXX`, `TPE`, `TOP`, `TTD`, `TND`, `TRY`, `TRL`, `TMT`, `TMM`, `USD`, `USN`, `USS`, `UGX`, `UGS`, `UAH`, `UAK`, `AED`, `UYW`, `UYU`, `UYP`, `UYI`, `UZS`, `VUV`, `VES`, `VEB`, `VEF`, `VND`, `VNN`, `CHE`, `CHW`, `XOF`, `YDD`, `YER`, `YUN`, `YUD`, `YUM`, `YUR`, `ZWN`, `ZRN`, `ZRZ`, `ZMW`, `ZMK`, `ZWD`, `ZWR`, `ZWL` - `feed_status` (enum, optional, nullable) — The status of the bank feed. - Allowed values: `ACTIVE`, `INACTIVE` - `feed_start_date` (datetime, optional, nullable) — The start date of the bank feed’s transactions. - `source_account_balance` (double, optional, nullable) — The current balance of funds in the source account. - `account_type` (enum, optional, nullable) — The type of the account. - Allowed values: `BANK`, `CREDIT_CARD` - `bank_feed_account_url` (string, optional, nullable) — The 3rd party URL of the bank feed account. - `remote_was_deleted` (boolean, optional) — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (BankFeedAccountFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) ### BankFeedAccountFieldMappings - `organization_defined_targets` (map from string to any, optional) - `linked_account_defined_targets` (map from string to any, optional) ### RemoteData # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ## Examples **Response** ```json { "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ", "results": [ { "id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390", "remote_id": "987300", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "source_account_id": "123566909", "target_account_id": "49cd5a42-b311-4750-9361-52e2ed1d4653", "source_account_name": "Travel Bank Account", "source_account_number": "12567", "target_account_name": "Netsuite Travel Bank Account", "currency": "USD", "feed_status": "ACTIVE", "feed_start_date": "2024-02-02T00:00:00.000Z", "source_account_balance": 123.94, "account_type": "BANK", "bank_feed_account_url": "https://qbo.intuit.com/app/bankfeedaccount/987300", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } }, "remote_data": [ { "path": "/platform-endpoint", "data": null } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/accounting/v1/bank-feed-accounts" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/accounting/v1/bank-feed-accounts?include_remote_data=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```