get https://uat-api.synapsefi.com/v3.1/users//nodes/
View a ACH-US
node
ACH Node Object
Key | Type | Description |
---|---|---|
_id | string | Object ID of the node |
_links.self.href | string | HAL-style link for the node |
allowed | string | Denotes available actions for the node. See Node Types and Node Statuses for more information |
client.id | string | ID of the client associated with the node |
client.name | string | Name of the client associated with the node |
extra.note | string | Account notes |
extra.other.access_token | string | Access token for node verification purposes |
extra.other.updated_on | integer | Date of last update to node (milliseconds since Unix epoch time). |
extra.supp_id | string | Supplementary ID provided on node creation |
info.account_num | string | Last 4 digits of the account number associated with the node |
info.address | string | Address of the bank associated with the account |
info.balance.amount | string | Current balance associated with the account |
info.balance.currency | string | Currency of the node |
info.balance.updated_on | integer | Date of last update to node balance (milliseconds since Unix epoch time). |
info.bank_code | string | Bank code |
info.bank_hlogo | string | Link to image of bank H logo |
info.bank_logo | string | Link to image of bank logo |
info.bank_long_name | string | Name of the bank associated with the account |
info.bank_name | string | Name of bank associated withe the account |
info.bank_url | string | URL for bank website |
info.class | string | Type of account (i.e. CHECKING , SAVINGS , etc.) |
info.name_on_account | string | Name of user associated with the account |
info.nickname | string | Nickname of node |
info.routing_num | string | Last 4 digits of the routing number associated with the node |
info.type | string | Type of account BUSINESS or PERSONAL |
info.match_info | object | For ACH transactions, an object describing if name, phone number, and email provided by the bank match the same values on file with Synapse. |
info.match_info.name_match | string | If the name on file matches name provided by bank. Can be "match", "no_match", or "not_found". If the name is either a match ( match ) or is not provided (not_found ), then ACH transactions should be allowed.NOTE: If name does not match, there are several there are scenarios in which the transaction will be queued: - if both email and phone numbers are not a match - if both email and phone number are not found - if email is not a match while phone number is not found - if email is not found while phone number is not a match |
info.match_info.phonenumber_match | string | If the phone number on file matches phone number provided by bank. Can be "match", "no_match", or "not_found". If phone number provided is a match ( match ), then ACH transactions should be allowed.NOTE: If name provided is not a match, there are scenarios in which the transaction will be queued. Please refer to info.match_info.name_match for more details. |
info.match_info.email_match | string | If the email address on file matches email address provided by bank. Can be "match", "no_match", or "not_found". If email address provided is a match ( match ), then ACH transactions should be allowed.NOTE: If name provided is not a match, there are scenarios in which the transaction will be queued. Please refer to info.match_info.name_match for more details. |
is_active | boolean | Denotes active status of node |
timeline | array of objects | List of updates to the node. See View ACH Account for more information |
type | string | Type of node. See Node Types and Node Statuses for more information |
user_id | string | User ID associate with node |
Timeline Object
Key | Type | Description |
---|---|---|
date | integer | Date of update to node (milliseconds since Unix epoch time). |
note | string | Note about the node update |
Force Refresh
If force refresh is successful, the
info.balance.updated_on
timestamp will update to the most recent date and time of update