Bank Feed Contacts
The BankFeedContact Object
A Rutter Bank Feed Contact represents the contact information associated with a bank account, including account holders, email addresses, physical addresses, and phone numbers. This data is sourced from Financial Institutions via the FDX /contact endpoint and can be used to verify account ownership and maintain up-to-date contact details.
Properties
idstringThe Rutter generated unique ID of the bank feed contact.
emailsarrayEmail addresses associated with the account.
String array.
phonesarrayPhone numbers for account contact.
phones attributesaccount_holdersarrayAccount holders with no correlation to their contact details.
account_holders attributesaddressesarrayPhysical mailing locations connected to the account.
addresses attributeslast_synced_atstringThe ISO 8601 timestamp when the bank feed contact was last synced by Rutter.
platform_dataobjectOptionalThe raw platform data corresponding to the Rutter object.
List Bank Feed Contacts
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
cursorstringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.
limitintegerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filterstringqueryOptionalNot currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.
Filterable fields: last_synced_at.
sortstringqueryOptionalUsed 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. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.
Sortable fields: last_synced_at.
expandenumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_minintegerqueryOptionalDeprecated - use filter instead. 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_maxintegerqueryOptionalDeprecated - use filter instead. 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_minintegerqueryOptionalDeprecated - use filter instead. 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_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
Fetch a Bank Feed Contact
Request Parameters
idstringpathRequiredThe unique ID of the object.
access_tokenstringqueryRequiredThe access token of the connection.
force_fetchenumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
Create a Bank Feed Contact
Request Parameters
access_tokenstringqueryRequiredThe access token of the connection.
Request Body
response_modeenumOptionalThe response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.
bank_feed_contactobjectbank_feed_contact attributesResponse Body
Have questions?
Contact support for personalized guidance.