{"_id":"59f79e3c584eb200345cec08","__v":0,"version":{"_id":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":8,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["59f79e3c584eb200345ceb3a","59f79e3c584eb200345ceb3b","59f79e3c584eb200345ceb3c","59f79e3c584eb200345ceb3d","59f79e3c584eb200345ceb3e","59f79e3c584eb200345ceb3f","59f79e3c584eb200345ceb45","59f79e3c584eb200345ceb46","59f79e3c584eb200345ceb48","59f79e3c584eb200345ceb49","5aa21b60c0bda0002d1568b6","5afb6888212c690003ae3d3b","5b4bdcd3737d1800031d2293","5b9ed89212362100036b5a1c","5bb29bec77c22500034757ea","5bb29bfe77c22500034757ec","5bc8fa8063924c00186c5ded","5bc8fe9fa472190014a6b103"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"59f79e3c584eb200345ceb3c","version":"59f79e3c584eb200345ceaff","project":"59f79e3c584eb200345ceafc","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T00:05:19.904Z","from_sync":false,"order":5,"slug":"nodes","title":"Nodes"},"parentDoc":null,"project":"59f79e3c584eb200345ceafc","user":"54e4044e8ef7552300409dcb","githubsync":"","updates":["56084bdbf93d3e0d009148e6","563d4147e79f670d00a10a60"],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T00:05:32.574Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Node resources are generic node classes that store basic information regarding a user's node (e.g. bank account, SynapseFI escrow account or wire instructions).\n\n## Node Types\n\nThe following are the node types currently supported:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Default Permissions\",\n    \"17-0\": \"\",\n    \"17-1\": \"\",\n    \"13-0\": \"WIRE-US\",\n    \"13-1\": \"CREDIT-AND-DEBIT\",\n    \"10-0\": \"ACH-US\",\n    \"10-1\": \"CREDIT (with AC/RT)\\nCREDIT-AND-DEBIT (with IAV)\",\n    \"14-0\": \"WIRE-INT\",\n    \"14-1\": \"CREDIT-AND-DEBIT\",\n    \"15-0\": \"IOU\",\n    \"15-1\": \"CREDIT-AND-DEBIT\",\n    \"18-0\": \"\",\n    \"18-1\": \"\",\n    \"19-0\": \"\",\n    \"19-1\": \"\",\n    \"20-0\": \"\",\n    \"20-1\": \"\",\n    \"21-0\": \"\",\n    \"21-1\": \"\",\n    \"h-2\": \"Comment\",\n    \"10-2\": \"A US bank account for processing ACH payments\",\n    \"13-2\": \"A US bank account for processing wire payments\",\n    \"14-2\": \"A non-US account for wire payments\",\n    \"15-2\": \"**[Deprecated]** Non-USD payments can be tracked using the IOU node type. This can be anything (e.g. another currency or commodity)\",\n    \"17-2\": \"\",\n    \"18-2\": \"\",\n    \"19-2\": \"\",\n    \"20-2\": \"\",\n    \"21-2\": \"\",\n    \"0-0\": \"DEPOSIT-US\",\n    \"0-1\": \"CREDIT-AND-DEBIT\",\n    \"0-2\": \"A Synapse node allows any user to hold funds. You can use this node as a wallet, an escrow account or something else along those lines\",\n    \"2-0\": \"SUBACCOUNT-US\",\n    \"2-1\": \"CREDIT-AND-DEBIT\",\n    \"2-2\": \"A subaccount inside a FBO account\",\n    \"4-0\": \"RESERVE-US\",\n    \"4-1\": \"CREDIT\",\n    \"4-2\": \"A Synapse node allows any user to hold funds. You can use this node for storing reserves with Synapse\",\n    \"8-0\": \"SYNAPSE-US\",\n    \"8-1\": \"CREDIT-AND-DEBIT\",\n    \"8-2\": \"**[Deprecated]** A Synapse node allows any user to hold funds. You can use this node as a wallet, an escrow account or something else along those lines\",\n    \"9-0\": \"TRIUMPH-SUBACCOUNT-US\",\n    \"9-1\": \"CREDIT-AND-DEBIT\",\n    \"9-2\": \"**[Deprecated]** A subaccount inside a FBO account at Triumph Bank\",\n    \"12-0\": \"CHECK-US\",\n    \"12-1\": \"CREDIT\",\n    \"12-2\": \"This node allows you to send a check to any individual or entity in the US\",\n    \"1-0\": \"IB-DEPOSIT-US\",\n    \"1-1\": \"CREDIT-AND-DEBIT\",\n    \"1-2\": \"Just like `DEPOSIT-US` but with an interest rate. Interest rates vary per platform but usually are around 1.00%\",\n    \"3-0\": \"IB-SUBACCOUNT-US\",\n    \"3-1\": \"CREDIT-AND-DEBIT\",\n    \"3-2\": \"Just like `SUBACCOUNT-US` but with an interest rate. Interest rates vary per platform but usually are around 1.00%\",\n    \"5-0\": \"CLEARING-US\",\n    \"5-1\": \"CREDIT-AND-DEBIT\",\n    \"5-2\": \"Clearing account on the name of the partner bank (not FDIC insured)\",\n    \"11-0\": \"INTERCHANGE-US\",\n    \"11-1\": \"CREDIT-AND-DEBIT (If push and pull enabled on card)\\nCREDIT (If only push enabled on card)\\nDEBIT (If only pull enabled on card)\",\n    \"11-2\": \"A Credit/Debit card for processing Interchange payments\",\n    \"6-0\": \"CARD-US\",\n    \"6-1\": \"INACTIVE (PHYSICAL)\\nCREDIT-AND-DEBIT (VIRTUAL)\",\n    \"6-2\": \"A physical or virtual debit card issued a user\",\n    \"7-0\": \"SUBCARD-US\",\n    \"7-1\": \"INACTIVE (PHYSICAL)\\nCREDIT-AND-DEBIT (VIRTUAL)\",\n    \"7-2\": \"A physical or virtual debit card issued to the platform for benefit of the user\",\n    \"16-0\": \"CRYPTO-US\",\n    \"16-1\": \"CREDIT-AND-DEBIT\",\n    \"16-2\": \"Crypto custodial account\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n## Node Permissions\n\nEvery node object has a set of permissions associated with them as follows.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Permission\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"CREDIT\",\n    \"2-0\": \"CREDIT-AND-DEBIT\",\n    \"5-0\": \"LOCKED\",\n    \"0-1\": \"Node can only receive funds.  In case of `ACH-US `  nodes, you need to [Verify Micro-deposit](doc:verify-micro-deposit) to obtain `CREDIT-AND-DEBIT` permission\",\n    \"2-1\": \"Node can be used for sending or receiving funds\",\n    \"5-1\": \"Node has been locked and cannot be used for any transactions\",\n    \"1-0\": \"DEBIT\",\n    \"1-1\": \"Node can only send funds. Currently only applicable for `INTERCHANGE-US`, If only pull enabled on card\",\n    \"3-0\": \"PENDING\",\n    \"4-0\": \"INACTIVE\",\n    \"4-1\": \"Node has been disabled and cannot be used for any transactions\",\n    \"3-1\": \"Node verification pending. Only used in case of `CARD-US` and `SUBCARD-US` when the card is waiting to be activated by the user\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\nWhen an `ACH-US` node is added with routing details, the node receives `CREDIT` only permissions and micro deposits are initiated to the node. Once micro deposits are verified, the account receives `CREDIT-AND-DEBIT` privileges.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Attempting micro-deposit verification\",\n  \"body\": \"Do not try to guess micro-deposit amounts. Nodes lock after 5 incorrect attempts. If the user has misplaced micro-deposits, we recommend using [Reinitiate Micro-deposits](doc:reinitiate-micro-deposits) API.\"\n}\n[/block]\n## ACH-US Account routing vs Instant Logins\n\nThere are two protocols available to attach an ACH-US account to a user: (1) supply the user's account / routing number; (2) supply the user's online banking login credentials (consumer accounts only).\n\nTo access the full list of banks supported by online banking logins, visit: [https://api.synapsefi.com/v3/institutions/show](https://api.synapsefi.com/v3/institutions/show).  Status updates for the bank logins can be found at [https://status.synapsefi.com](https://status.synapsefi.com).\n\n## All Deposit Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>name_on_account<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Name of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Balance associated with the node.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Currency of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>user_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## All Issued Debit Card Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>document_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>User's document ID that the card is associated with</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>card_type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Card type. <code>PHYSICAL</code> or <code>VIRTUAL</code>.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Avaliable balance on the card</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Avaliable balance's currency on the card</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.preferences.</span>allow_foreign_transactions<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">false</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Allow foreign transaction on card</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.preferences.</span>atm_withdrawal_limit<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><span class=\\\"param-default text-muted\\\">1000</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Daily ATM cash withdrawal limit</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.preferences.</span>max_pin_attempts<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><span class=\\\"param-default text-muted\\\">3</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Max consecutive incorrect pin attempts allowed before card is locked</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.preferences.</span>pos_withdrawal_limit<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">integer</strong><span class=\\\"param-default text-muted\\\">1000</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Daily cash withdrawal limit on POS (Point of Sale)</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.preferences.</span>security_alerts<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Text message alert on suspicious activity</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## ACH-US Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>account_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Last 4 digits of the account number associated with the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>address<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Balance associated with the node.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Currency of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_long_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>class<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">CHECKING</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Class of account. <code>CHECKING</code>,  <code>SAVINGS</code>, <code>GENERAL_LEDGER</code> or <code>LOAN</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.match_info.</span>email_match<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If node is added with IAV, then this fields tells you if email on user profile matches the email on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.match_info.</span>name_match<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If node is added with IAV, then this fields tells you if name on user profile matches the name on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.match_info.</span>phonenumber_match<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If node is added with IAV, then this fields tells you if phone number on user profile matches the phone number on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>name_on_account<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Name of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>routing_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Last 4 digits of the routing number associated with the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">PERSONAL</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## INTERCHANGE-US Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>document_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>User's document ID that the card is associated with</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>network<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Card's network. <code>VISA</code>, <code>MASTERCARD</code>, <code>DISCOVER</code>.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Card type <code>DEBIT</code>, <code>CREDIT</code>, <code>PREPAID</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>card_hash<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>A hash value derived from card details. This will be same for cards with same card details</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>is_international<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>true if the card is not a US based</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## CHECK-US Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>note<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any note you wish to add with the check. If paying a bill, this could be an account number or name of the user.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>payee_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the payee</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.payee_address.</span>address_street<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.payee_address.</span>address_city<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.payee_address.</span>address_subdivision<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.payee_address.</span>address_country_code<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.payee_address.</span>address_postal_code<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## WIRE-US Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>account_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Last 4 digits of the account number associated with the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>address<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Balance associated with the node.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Currency of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_long_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>name_on_account<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Name of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>routing_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Last 4 digits of the routing number associated with the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">PERSONAL</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## WIRE-INT Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>account_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Last 4 digits of the account number associated with the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>address<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Address of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>amount<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Balance associated with the node.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.balance.</span>currency<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">USD</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Currency of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>bank_long_name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the bank</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>name_on_account<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>[Deprecated] Name of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><span class=\\\"param-default text-muted\\\">PERSONAL</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]\n## CRYPTO-US Node Object\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"><hr class=\\\"bottom\\\"><div class=\\\"param-table\\\"><div class=\\\"table\\\"><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Object ID of the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">_links.self.</span>href<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>HAL style link for the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>allowed<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Denotes the account standing. Look at the <a href=\\\"#section-node-permissions\\\">node permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">client.</span>name<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Name of the client that created the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.</span>nickname<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.portfolio.</span>BTC<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>BTC holding</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">info.portfolio.</span>ETH<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">double</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ETH holdings</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>type<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Type of node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>timeline<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">array of objects</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Array that tracks node updates as they occur</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>is_active<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">boolean</strong><span class=\\\"param-default text-muted\\\">true</span><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>If the node is indexed or marked deleted.</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>user_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>ID of the user who owns the node</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">extra.</span>supp_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Any supplied ID given by the client that created the node</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]","excerpt":"","slug":"node-resources","type":"basic","title":"Node Resources"}
Node resources are generic node classes that store basic information regarding a user's node (e.g. bank account, SynapseFI escrow account or wire instructions). ## Node Types The following are the node types currently supported: [block:parameters] { "data": { "h-0": "Type", "h-1": "Default Permissions", "17-0": "", "17-1": "", "13-0": "WIRE-US", "13-1": "CREDIT-AND-DEBIT", "10-0": "ACH-US", "10-1": "CREDIT (with AC/RT)\nCREDIT-AND-DEBIT (with IAV)", "14-0": "WIRE-INT", "14-1": "CREDIT-AND-DEBIT", "15-0": "IOU", "15-1": "CREDIT-AND-DEBIT", "18-0": "", "18-1": "", "19-0": "", "19-1": "", "20-0": "", "20-1": "", "21-0": "", "21-1": "", "h-2": "Comment", "10-2": "A US bank account for processing ACH payments", "13-2": "A US bank account for processing wire payments", "14-2": "A non-US account for wire payments", "15-2": "**[Deprecated]** Non-USD payments can be tracked using the IOU node type. This can be anything (e.g. another currency or commodity)", "17-2": "", "18-2": "", "19-2": "", "20-2": "", "21-2": "", "0-0": "DEPOSIT-US", "0-1": "CREDIT-AND-DEBIT", "0-2": "A Synapse node allows any user to hold funds. You can use this node as a wallet, an escrow account or something else along those lines", "2-0": "SUBACCOUNT-US", "2-1": "CREDIT-AND-DEBIT", "2-2": "A subaccount inside a FBO account", "4-0": "RESERVE-US", "4-1": "CREDIT", "4-2": "A Synapse node allows any user to hold funds. You can use this node for storing reserves with Synapse", "8-0": "SYNAPSE-US", "8-1": "CREDIT-AND-DEBIT", "8-2": "**[Deprecated]** A Synapse node allows any user to hold funds. You can use this node as a wallet, an escrow account or something else along those lines", "9-0": "TRIUMPH-SUBACCOUNT-US", "9-1": "CREDIT-AND-DEBIT", "9-2": "**[Deprecated]** A subaccount inside a FBO account at Triumph Bank", "12-0": "CHECK-US", "12-1": "CREDIT", "12-2": "This node allows you to send a check to any individual or entity in the US", "1-0": "IB-DEPOSIT-US", "1-1": "CREDIT-AND-DEBIT", "1-2": "Just like `DEPOSIT-US` but with an interest rate. Interest rates vary per platform but usually are around 1.00%", "3-0": "IB-SUBACCOUNT-US", "3-1": "CREDIT-AND-DEBIT", "3-2": "Just like `SUBACCOUNT-US` but with an interest rate. Interest rates vary per platform but usually are around 1.00%", "5-0": "CLEARING-US", "5-1": "CREDIT-AND-DEBIT", "5-2": "Clearing account on the name of the partner bank (not FDIC insured)", "11-0": "INTERCHANGE-US", "11-1": "CREDIT-AND-DEBIT (If push and pull enabled on card)\nCREDIT (If only push enabled on card)\nDEBIT (If only pull enabled on card)", "11-2": "A Credit/Debit card for processing Interchange payments", "6-0": "CARD-US", "6-1": "INACTIVE (PHYSICAL)\nCREDIT-AND-DEBIT (VIRTUAL)", "6-2": "A physical or virtual debit card issued a user", "7-0": "SUBCARD-US", "7-1": "INACTIVE (PHYSICAL)\nCREDIT-AND-DEBIT (VIRTUAL)", "7-2": "A physical or virtual debit card issued to the platform for benefit of the user", "16-0": "CRYPTO-US", "16-1": "CREDIT-AND-DEBIT", "16-2": "Crypto custodial account" }, "cols": 3, "rows": 17 } [/block] ## Node Permissions Every node object has a set of permissions associated with them as follows. [block:parameters] { "data": { "h-0": "Permission", "h-1": "Comment", "0-0": "CREDIT", "2-0": "CREDIT-AND-DEBIT", "5-0": "LOCKED", "0-1": "Node can only receive funds. In case of `ACH-US ` nodes, you need to [Verify Micro-deposit](doc:verify-micro-deposit) to obtain `CREDIT-AND-DEBIT` permission", "2-1": "Node can be used for sending or receiving funds", "5-1": "Node has been locked and cannot be used for any transactions", "1-0": "DEBIT", "1-1": "Node can only send funds. Currently only applicable for `INTERCHANGE-US`, If only pull enabled on card", "3-0": "PENDING", "4-0": "INACTIVE", "4-1": "Node has been disabled and cannot be used for any transactions", "3-1": "Node verification pending. Only used in case of `CARD-US` and `SUBCARD-US` when the card is waiting to be activated by the user" }, "cols": 2, "rows": 6 } [/block] When an `ACH-US` node is added with routing details, the node receives `CREDIT` only permissions and micro deposits are initiated to the node. Once micro deposits are verified, the account receives `CREDIT-AND-DEBIT` privileges. [block:callout] { "type": "info", "title": "Attempting micro-deposit verification", "body": "Do not try to guess micro-deposit amounts. Nodes lock after 5 incorrect attempts. If the user has misplaced micro-deposits, we recommend using [Reinitiate Micro-deposits](doc:reinitiate-micro-deposits) API." } [/block] ## ACH-US Account routing vs Instant Logins There are two protocols available to attach an ACH-US account to a user: (1) supply the user's account / routing number; (2) supply the user's online banking login credentials (consumer accounts only). To access the full list of banks supported by online banking logins, visit: [https://api.synapsefi.com/v3/institutions/show](https://api.synapsefi.com/v3/institutions/show). Status updates for the bank logins can be found at [https://status.synapsefi.com](https://status.synapsefi.com). ## All Deposit Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>name_on_account<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Name of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Balance associated with the node.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Currency of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>user_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## All Issued Debit Card Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>document_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>User's document ID that the card is associated with</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>card_type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Card type. <code>PHYSICAL</code> or <code>VIRTUAL</code>.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Avaliable balance on the card</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Avaliable balance's currency on the card</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.preferences.</span>allow_foreign_transactions<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">false</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Allow foreign transaction on card</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.preferences.</span>atm_withdrawal_limit<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><span class=\"param-default text-muted\">1000</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Daily ATM cash withdrawal limit</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.preferences.</span>max_pin_attempts<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><span class=\"param-default text-muted\">3</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Max consecutive incorrect pin attempts allowed before card is locked</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.preferences.</span>pos_withdrawal_limit<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">integer</strong><span class=\"param-default text-muted\">1000</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Daily cash withdrawal limit on POS (Point of Sale)</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.preferences.</span>security_alerts<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Text message alert on suspicious activity</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## ACH-US Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>account_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Last 4 digits of the account number associated with the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>address<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Balance associated with the node.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Currency of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_long_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>class<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">CHECKING</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Class of account. <code>CHECKING</code>, <code>SAVINGS</code>, <code>GENERAL_LEDGER</code> or <code>LOAN</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.match_info.</span>email_match<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>If node is added with IAV, then this fields tells you if email on user profile matches the email on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.match_info.</span>name_match<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>If node is added with IAV, then this fields tells you if name on user profile matches the name on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.match_info.</span>phonenumber_match<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>If node is added with IAV, then this fields tells you if phone number on user profile matches the phone number on the bank. Possible values: <code>match</code>, <code>no_match</code>, <code>not_found</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>name_on_account<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Name of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>routing_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Last 4 digits of the routing number associated with the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">PERSONAL</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## INTERCHANGE-US Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>document_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>User's document ID that the card is associated with</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>network<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Card's network. <code>VISA</code>, <code>MASTERCARD</code>, <code>DISCOVER</code>.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Card type <code>DEBIT</code>, <code>CREDIT</code>, <code>PREPAID</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>card_hash<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>A hash value derived from card details. This will be same for cards with same card details</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>is_international<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>true if the card is not a US based</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## CHECK-US Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>note<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any note you wish to add with the check. If paying a bill, this could be an account number or name of the user.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>payee_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the payee</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.payee_address.</span>address_street<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.payee_address.</span>address_city<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.payee_address.</span>address_subdivision<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.payee_address.</span>address_country_code<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.payee_address.</span>address_postal_code<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the payee, this can be home address of a person or business address of a corp.</p>\n</div></div></div></div></div></div>" } [/block] ## WIRE-US Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>account_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Last 4 digits of the account number associated with the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>address<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Balance associated with the node.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Currency of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_long_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>name_on_account<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Name of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>routing_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Last 4 digits of the routing number associated with the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">PERSONAL</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## WIRE-INT Node Object [block:html] { "html": "<div class=\"api-manager\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>account_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Last 4 digits of the account number associated with the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>address<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Address of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>amount<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Balance associated with the node.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.balance.</span>currency<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">USD</span><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Currency of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>bank_long_name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the bank</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>name_on_account<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>[Deprecated] Name of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><span class=\"param-default text-muted\">PERSONAL</span><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of bank account. <code>PERSONAL</code> or <code>BUSINESS</code></p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block] ## CRYPTO-US Node Object [block:html] { "html": "<div class=\"api-manager\"><hr class=\"bottom\"><div class=\"param-table\"><div class=\"table\"><div class=\"tr\"><div class=\"td param\"><strong>_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Object ID of the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">_links.self.</span>href<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>HAL style link for the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>allowed<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Denotes the account standing. Look at the <a href=\"#section-node-permissions\">node permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">client.</span>name<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Name of the client that created the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.</span>nickname<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any nickname/common name given to the node. Eg. Savings Node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.portfolio.</span>BTC<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>BTC holding</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">info.portfolio.</span>ETH<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">double</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ETH holdings</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>type<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Type of node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>timeline<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">array of objects</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Array that tracks node updates as they occur</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>is_active<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">boolean</strong><span class=\"param-default text-muted\">true</span><div marked=\"\" class=\"ng-isolate-scope\"><p>If the node is indexed or marked deleted.</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>user_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>ID of the user who owns the node</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">extra.</span>supp_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Any supplied ID given by the client that created the node</p>\n</div></div></div></div></div></div>" } [/block]