{"_id":"5bb55cbe478c1300031a44c6","project":"59f79e3c584eb200345ceafc","version":{"_id":"5ba178b00a916500030c6a21","project":"59f79e3c584eb200345ceafc","__v":24,"forked_from":"59f79e3c584eb200345ceaff","createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["5ba178b00a916500030c69a2","5ba178b00a916500030c69a3","5ba178b00a916500030c69a4","5ba178b00a916500030c69a5","5ba178b00a916500030c69a6","5ba178b00a916500030c69a7","5ba178b00a916500030c69a8","5ba178b00a916500030c69a9","5ba178b00a916500030c69aa","5ba178b00a916500030c69ab","5ba178b00a916500030c69ac","5afb6888212c690003ae3d3b","5ba178b00a916500030c69ad","5ba178b00a916500030c69ae","5ba2dcbc99f53f0003b97e2c","5babd73fa0ab3e0003ead030","5bb4038be7222e000334dd97","5bb55954478c1300031a44c2","5bb665a1607307000327c81e","5bb6f90229a7fb0003a0650d","5bb7f9bc29a7fb0003a07ac1","5bba58bd7ba7710003bd901d","5bba6dac7ba7710003bd908d","5bba6e257ba7710003bd9090","5bbac87810189c0003e619ea","5bbb9d02b5862c00036266b2","5bbbadb6219c3e000376c2de","5bc417751d1b0000182bf7f6","5bc59e3b2a5b4f0044db5b97","5bc7bbce2262cc0041f6eff2","5bce6a3580a7250031199f34","5bcfac2c4082510019f2d91b","5bcfac3757bed90030e45d68","5bcfac45d305bc0049941539","5bd2a43548bb6f00289c8fad","5bd3a42a026ebe001f66259e","5bd9d5afffe003005b02f97b","5becb7ee85c6b300557662b6"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":false,"codename":"","version_clean":"3.2.0","version":"3.2"},"category":{"_id":"5bb55954478c1300031a44c2","project":"59f79e3c584eb200345ceafc","version":"5ba178b00a916500030c6a21","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-10-04T00:05:40.532Z","from_sync":false,"order":4,"slug":"wires","title":"Wires"},"user":"5a68eb6970ea610012bfb924","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-10-04T00:20:14.617Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"Reminder: Please [create a user](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) with the necessary KYC, then [OAuth the user](https://docs.synapsefi.com/v3.2/docs/oauth-the-user) to perform actions on their behalf.\n\nTo send outgoing wires, link a wire account to the recipient. The wire account can be a domestic wire account (WIRE-US node) or an international wire account (WIRE-INT node).\n\n##API Endpoint\nhttps://uat-api.synapsefi.com/v3.1/users/:user_id/nodes\n\n##PATH PARAMETER##\n[block:html]\n{\n  \"html\": \"<div class=\\\"api-manager\\\"> <div class=\\\"param-table\\\"> <div class=\\\"table\\\"> <h4 class=\\\"paramGroupTitle\\\">Path Params</h4> <div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong>user_id <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>The user ID of the user you wish to add the WIRE-US node under</p></div></div></div></div></div></div>\"\n}\n[/block]\n##BODY PARAMETER##\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>type <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Type of node you wish to add</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.</span>nickname <span class=\\\"colon\\\">:</span> </strong> <div class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Nickname for the node</p></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 class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Account number associated with the bank</p></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 class=\\\"required\\\">required</div></div><div class=\\\"td\\\"> <strong class=\\\"param-type\\\">string</strong> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>Routing number associated with the bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_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>Routing number of correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_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 correspondent bank</p></div></div></div><div class=\\\"tr\\\"> <div class=\\\"td param\\\"> <strong> <span class=\\\"text-muted\\\">info.correspondent_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 correspondent bank</p></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 ID you wish to register to the node</p></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> <div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"> <p>If the node is indexed or marked deleted</p></div></div></div></div></div></div>\"\n}\n[/block]\n**Node Permissions**\nEvery account has the following permissions associated with them:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Permission\",\n    \"h-1\": \"Comments\",\n    \"0-0\": \"CREDIT-AND-DEBIT\",\n    \"0-1\": \"Node can be used for sending and receiving funds\",\n    \"1-0\": \"INACTIVE\",\n    \"2-0\": \"LOCKED\",\n    \"1-1\": \"Node has been disabled and cannot be used for any transactions\",\n    \"2-1\": \"Node has been locked and cannot be used for any transactions\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n## Example Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v3.1/users/5bb5258fb9b35b0094e508fc/nodes HTTP/1.1\\nHost: uat-api.synapsefi.com\\nX-SP-USER-IP: 127.0.0.1\\nX-SP-USER: oauth_053uaoUncXmjJlDYONfdBPLypKIiZFxMbQhRg417|n38dj3h8NE393bv24ovoRY34kd62\\nContent-Type: application/json\\n\\n\\n{\\n  \\\"type\\\": \\\"WIRE-US\\\",\\n  \\\"info\\\":{\\n      \\\"nickname\\\": \\\"Some Account\\\",\\n      \\\"account_num\\\": \\\"1235674342\\\",\\n      \\\"routing_num\\\": \\\"026009593\\\"\\n    }\\n}\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Example Successful 200 Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"error_code\\\": \\\"0\\\",\\n    \\\"http_code\\\": \\\"200\\\",\\n    \\\"limit\\\": 20,\\n    \\\"node_count\\\": 1,\\n    \\\"nodes\\\": [\\n        {\\n            \\\"_id\\\": \\\"5bb55d0496a16c009fff2dfc\\\",\\n            \\\"_links\\\": {\\n                \\\"self\\\": {\\n                    \\\"href\\\": \\\"https://uat-api.synapsefi.com/v3.1/users/5bb5258fb9b35b0094e508fc/nodes/5bb55d0496a16c009fff2dfc\\\"\\n                }\\n            },\\n            \\\"allowed\\\": \\\"CREDIT-AND-DEBIT\\\",\\n            \\\"client\\\": {\\n                \\\"id\\\": \\\"5ade26b4567a900029e2afd2\\\",\\n                \\\"name\\\": \\\"YY Test Account\\\"\\n            },\\n            \\\"extra\\\": {\\n                \\\"note\\\": null,\\n                \\\"other\\\": {},\\n                \\\"supp_id\\\": \\\"\\\"\\n            },\\n            \\\"info\\\": {\\n                \\\"account_num\\\": \\\"4342\\\",\\n                \\\"address\\\": \\\"NEW YORK, NY, US\\\",\\n                \\\"balance\\\": {\\n                    \\\"amount\\\": \\\"0.00\\\",\\n                    \\\"currency\\\": \\\"USD\\\"\\n                },\\n                \\\"bank_logo\\\": \\\"https://cdn.synapsepay.com/bank_logos/new/bofa.png\\\",\\n                \\\"bank_long_name\\\": \\\"BANK OF AMERICA, NY\\\",\\n                \\\"bank_name\\\": \\\"BANK OF AMERICA, NY\\\",\\n                \\\"correspondent_info\\\": {\\n                    \\\"address\\\": null,\\n                    \\\"bank_name\\\": null,\\n                    \\\"routing_num\\\": null\\n                },\\n                \\\"name_on_account\\\": \\\" \\\",\\n                \\\"nickname\\\": \\\"Some Account\\\",\\n                \\\"routing_num\\\": \\\"9593\\\"\\n            },\\n            \\\"is_active\\\": true,\\n            \\\"timeline\\\": [\\n                {\\n                    \\\"date\\\": 1538612484024,\\n                    \\\"note\\\": \\\"Node created.\\\"\\n                }\\n            ],\\n            \\\"type\\\": \\\"WIRE-US\\\",\\n            \\\"user_id\\\": \\\"5bb5258fb9b35b0094e508fc\\\"\\n        }\\n    ],\\n    \\\"page_count\\\": 1,\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Subscribe to Webhooks\",\n  \"body\": \"We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of nodes.\"\n}\n[/block]","excerpt":"POST WIRE-US node to add wiring instructions.","slug":"opening-a-wire-account","type":"basic","title":"Link a Wire Account"}

Link a Wire Account

POST WIRE-US node to add wiring instructions.

Reminder: Please [create a user](https://docs.synapsefi.com/v3.2/docs/create-a-user-1) with the necessary KYC, then [OAuth the user](https://docs.synapsefi.com/v3.2/docs/oauth-the-user) to perform actions on their behalf. To send outgoing wires, link a wire account to the recipient. The wire account can be a domestic wire account (WIRE-US node) or an international wire account (WIRE-INT node). ##API Endpoint https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes ##PATH PARAMETER## [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <h4 class=\"paramGroupTitle\">Path Params</h4> <div class=\"tr\"> <div class=\"td param\"> <strong>user_id <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>The user ID of the user you wish to add the WIRE-US node under</p></div></div></div></div></div></div>" } [/block] ##BODY PARAMETER## [block:html] { "html": "<div class=\"api-manager\"> <div class=\"param-table\"> <div class=\"table\"> <div class=\"tr\"> <div class=\"td param\"> <strong>type <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Type of node you wish to add</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.</span>nickname <span class=\"colon\">:</span> </strong> <div class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Nickname for the node</p></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 class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Account number associated with the bank</p></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 class=\"required\">required</div></div><div class=\"td\"> <strong class=\"param-type\">string</strong> <div marked=\"\" class=\"ng-isolate-scope\"> <p>Routing number associated with the bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_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>Routing number of correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_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 correspondent bank</p></div></div></div><div class=\"tr\"> <div class=\"td param\"> <strong> <span class=\"text-muted\">info.correspondent_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 correspondent bank</p></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 ID you wish to register to the node</p></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> <div marked=\"\" class=\"ng-isolate-scope\"> <p>If the node is indexed or marked deleted</p></div></div></div></div></div></div>" } [/block] **Node Permissions** Every account has the following permissions associated with them: [block:parameters] { "data": { "h-0": "Permission", "h-1": "Comments", "0-0": "CREDIT-AND-DEBIT", "0-1": "Node can be used for sending and receiving funds", "1-0": "INACTIVE", "2-0": "LOCKED", "1-1": "Node has been disabled and cannot be used for any transactions", "2-1": "Node has been locked and cannot be used for any transactions" }, "cols": 2, "rows": 3 } [/block] ## Example Request [block:code] { "codes": [ { "code": "POST /v3.1/users/5bb5258fb9b35b0094e508fc/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_053uaoUncXmjJlDYONfdBPLypKIiZFxMbQhRg417|n38dj3h8NE393bv24ovoRY34kd62\nContent-Type: application/json\n\n\n{\n \"type\": \"WIRE-US\",\n \"info\":{\n \"nickname\": \"Some Account\",\n \"account_num\": \"1235674342\",\n \"routing_num\": \"026009593\"\n }\n}", "language": "http" } ] } [/block] ## Example Successful 200 Response [block:code] { "codes": [ { "code": "{\n \"error_code\": \"0\",\n \"http_code\": \"200\",\n \"limit\": 20,\n \"node_count\": 1,\n \"nodes\": [\n {\n \"_id\": \"5bb55d0496a16c009fff2dfc\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://uat-api.synapsefi.com/v3.1/users/5bb5258fb9b35b0094e508fc/nodes/5bb55d0496a16c009fff2dfc\"\n }\n },\n \"allowed\": \"CREDIT-AND-DEBIT\",\n \"client\": {\n \"id\": \"5ade26b4567a900029e2afd2\",\n \"name\": \"YY Test Account\"\n },\n \"extra\": {\n \"note\": null,\n \"other\": {},\n \"supp_id\": \"\"\n },\n \"info\": {\n \"account_num\": \"4342\",\n \"address\": \"NEW YORK, NY, US\",\n \"balance\": {\n \"amount\": \"0.00\",\n \"currency\": \"USD\"\n },\n \"bank_logo\": \"https://cdn.synapsepay.com/bank_logos/new/bofa.png\",\n \"bank_long_name\": \"BANK OF AMERICA, NY\",\n \"bank_name\": \"BANK OF AMERICA, NY\",\n \"correspondent_info\": {\n \"address\": null,\n \"bank_name\": null,\n \"routing_num\": null\n },\n \"name_on_account\": \" \",\n \"nickname\": \"Some Account\",\n \"routing_num\": \"9593\"\n },\n \"is_active\": true,\n \"timeline\": [\n {\n \"date\": 1538612484024,\n \"note\": \"Node created.\"\n }\n ],\n \"type\": \"WIRE-US\",\n \"user_id\": \"5bb5258fb9b35b0094e508fc\"\n }\n ],\n \"page_count\": 1,\n \"success\": true\n}", "language": "json" } ] } [/block] [block:callout] { "type": "info", "title": "Subscribe to Webhooks", "body": "We recommend that you [subscribe to webhooks](https://docs.synapsefi.com/v3.2/docs/subscribe-to-webhooks) to stay updated on the status of nodes." } [/block]