{"_id":"59c9f19cdf09ad001ab55eac","project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":11,"createdAt":"2015-09-17T03:47:20.956Z","releaseDate":"2015-09-17T03:47:20.956Z","categories":["55fa37ca8065a10d004e5bb7","55fa37ca8065a10d004e5bb8","55fa37ca8065a10d004e5bb9","55fa37ca8065a10d004e5bba","55fca6bf34ae7c0d00ab8ea0","55ff80fd9e7ccf0d000a1d93","560220af7435de0d00fabd0d","56107f21bb9d920d00303e70","563e184077681a0d00d96a02","56fafc6596ec7e0e002ac85f","5915e54f7c2c552d008b8549","59499fcd64b5f5002690bbc1","59c451b7772699001c0f1df1","59c9b42dec84880010c1f348"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"category":{"_id":"59c9b42dec84880010c1f348","project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-26T01:58:05.060Z","from_sync":false,"order":8,"slug":"subnets","title":"Subnets"},"user":"54e4044e8ef7552300409dcb","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-26T06:20:12.582Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Sandbox Only\",\n  \"body\": \"Currently Subnets are avaliable on sandbox only\"\n}\n[/block]\nSubnets resources are generic subnet classes that store basic information regarding a node's subnet.\n\nSubnets are virtual account and routing numbers issued on top of Synapse managed [Deposit Accounts](doc:deposit-accounts). Developers can use subnets to allow uses to be able to fund their deposit account via external ACH or Wire transfers.\n\nThese account and routing numbers can be plugged into any third party software that is capable of sending ACHs or Wires and when the transfers arrive, a [transaction](doc:trans-resources) will be created automatically and funds will be added on to the associated deposit account.\n\n## Subnet Permissions\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Permission\",\n    \"h-1\": \"Comment\",\n    \"0-0\": \"CREDIT\",\n    \"1-0\": \"LOCKED\",\n    \"1-1\": \"Subnet has been locked and any new credits will be returned\",\n    \"0-1\": \"Subnet can receive funds via ACH or Wire transfers\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nEvery subnet object has a set of permissions associated with them as follows.\n\n## Subnet 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 a transaction</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>account_num<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Account number associated with the subnet</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 where the transaction initiated</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 where the transaction initiated</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 subnet standing. Look at <a href=\\\"#section-subnet-permissions\\\">subnet permissions</a> section above to learn more</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>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. Payroll AC/RT</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong>node_id<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Node ID associated with the subnet. Funds will be credited to this node when credits arrive</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">routing_num.</span>ach<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Routing number for ACH transfers</p>\\n</div></div></div><div class=\\\"tr\\\"><div class=\\\"td param\\\"><strong><span class=\\\"text-muted\\\">routing_num.</span>wire<span class=\\\"colon\\\">:</span></strong></div><div class=\\\"td\\\"><strong class=\\\"param-type\\\">string</strong><div marked=\\\"\\\" class=\\\"ng-isolate-scope\\\"><p>Routing number for wire transfers</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>User ID of the user who owns the subnet</p>\\n</div></div></div></div></div></div>\"\n}\n[/block]","excerpt":"","slug":"subnets","type":"basic","title":"Subnets"}
[block:callout] { "type": "info", "title": "Sandbox Only", "body": "Currently Subnets are avaliable on sandbox only" } [/block] Subnets resources are generic subnet classes that store basic information regarding a node's subnet. Subnets are virtual account and routing numbers issued on top of Synapse managed [Deposit Accounts](doc:deposit-accounts). Developers can use subnets to allow uses to be able to fund their deposit account via external ACH or Wire transfers. These account and routing numbers can be plugged into any third party software that is capable of sending ACHs or Wires and when the transfers arrive, a [transaction](doc:trans-resources) will be created automatically and funds will be added on to the associated deposit account. ## Subnet Permissions [block:parameters] { "data": { "h-0": "Permission", "h-1": "Comment", "0-0": "CREDIT", "1-0": "LOCKED", "1-1": "Subnet has been locked and any new credits will be returned", "0-1": "Subnet can receive funds via ACH or Wire transfers" }, "cols": 2, "rows": 2 } [/block] Every subnet object has a set of permissions associated with them as follows. ## Subnet 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 a transaction</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>account_num<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Account number associated with the subnet</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 where the transaction initiated</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 where the transaction initiated</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 subnet standing. Look at <a href=\"#section-subnet-permissions\">subnet permissions</a> section above to learn more</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>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. Payroll AC/RT</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong>node_id<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Node ID associated with the subnet. Funds will be credited to this node when credits arrive</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">routing_num.</span>ach<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Routing number for ACH transfers</p>\n</div></div></div><div class=\"tr\"><div class=\"td param\"><strong><span class=\"text-muted\">routing_num.</span>wire<span class=\"colon\">:</span></strong></div><div class=\"td\"><strong class=\"param-type\">string</strong><div marked=\"\" class=\"ng-isolate-scope\"><p>Routing number for wire transfers</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>User ID of the user who owns the subnet</p>\n</div></div></div></div></div></div>" } [/block]