{"_id":"594e6595a71a3d00531d4fd1","project":"54e405191e51932d006abc39","version":{"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","__v":9,"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"],"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":"55fca6bf34ae7c0d00ab8ea0","version":"55fa37c88065a10d004e5bb6","pages":["55ff4f549f5a880d00a6c32b","55ff52fa9f5a880d00a6c32d","55ff54365c67200d00fa2fb6","55ff57305c67200d00fa2fc0","55ff583f948a830d0023a64a","55ff5a11948a830d0023a659","55ff6162feaf310d007dd66a","55ff62289e7ccf0d000a1d7a","55ff6455feaf310d007dd66b","55ff71436932a00d00ba7a3b","55ff814c8c0c9d0d00dcac33","55ff81ecfeaf310d007dd67f","55ff890a8c0c9d0d00dcac51","55ff89778c0c9d0d00dcac52","55ff8e50feaf310d007dd68d","55ff8edd0e2b090d00863365"],"project":"54e405191e51932d006abc39","__v":16,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T00:05:19.904Z","from_sync":false,"order":5,"slug":"nodes","title":"Nodes"},"user":"54e4044e8ef7552300409dcb","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-24T13:13:57.379Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1\nHost: uat-api.synapsefi.com\nX-SP-USER-IP: 127.0.0.1\nX-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc\nContent-Type: application/json\n\n{\n  \"type\": \"DEPOSIT-US\",\n  \"info\":{\n      \"nickname\":\"My Checking\"\n  }\n}","language":"http"}]},"settings":"","results":{"codes":[{"code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\n            \"_id\": \"594e65f712e17a002f2e357c\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e65f712e17a002f2e357c\"\n                }\n            },\n            \"allowed\": \"CREDIT-AND-DEBIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"other\": {},\n                \"supp_id\": \"\"\n            },\n            \"info\": {\n                \"balance\": {\n                    \"amount\": 0,\n                    \"currency\": \"USD\"\n                },\n                \"name_on_account\": \" \",\n                \"nickname\": \"My Checking\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1498310135274,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"DEPOSIT-US\",\n            \"user_id\": \"594e0fa2838454002ea317a0\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":"","status":200,"language":"json"}]},"method":"post","auth":"required","params":[{"_id":"5573b11e91ce6e190023b76a","ref":"","in":"body","required":true,"desc":"Type of node you wish to add","default":"","type":"string","name":"type"},{"_id":"55fa4d6f764f5021009506c9","ref":"","in":"body","required":true,"desc":"Nickname associated with the node","default":"","type":"string","name":"info.nickname"},{"_id":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the node","default":"","type":"string","name":"extra.supp_id"},{"_id":"58fe931a59079e190092fa48","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the SYNAPSE-US node under","default":"","type":"string","name":"user_id"},{"_id":"594e65af283bee0035df6b56","ref":"","in":"body","required":false,"desc":"If the node is indexed or marked deleted.","default":"","type":"boolean","name":"is_active"}],"url":"/v3.1/users/:user_id/nodes"},"isReference":true,"order":6,"body":"[block:api-header]\n{}\n[/block]\n## Deposit Account types\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Default Permissions\",\n    \"h-2\": \"Comment\",\n    \"0-0\": \"DEPOSIT-US\",\n    \"0-1\": \"CREDIT-AND-DEBIT\",\n    \"0-2\": \"A Synapse node that allows any user to hold funds. You can use this node as a wallet, an escrow account, etc.\",\n    \"1-0\": \"SUBACCOUNT-US\",\n    \"1-1\": \"CREDIT-AND-DEBIT\",\n    \"1-2\": \"A subaccount inside an FBO account.\",\n    \"2-0\": \"RESERVE-US\",\n    \"2-1\": \"CREDIT\",\n    \"2-2\": \"A Synapse node that allows any user to hold funds. You can use this node for storing reserves with Synapse.\",\n    \"3-0\": \"SYNAPSE-US\",\n    \"3-1\": \"CREDIT-AND-DEBIT\",\n    \"3-2\": \"**[Deprecated]** A Synapse node that allows any user to hold funds. You can use this node as a wallet, an escrow account, etc.\",\n    \"4-0\": \"TRIUMPH-SUBACCOUNT-US\",\n    \"4-1\": \"CREDIT-AND-DEBIT\",\n    \"4-2\": \"**[Deprecated]** A subaccount inside a FBO account at Triumph Bank.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Create a Deposit node","slug":"deposit-accounts","type":"endpoint","title":"Deposit Accounts"}

postDeposit Accounts

Create a Deposit node

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string
The user ID of the user you wish to add the SYNAPSE-US node under

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname associated with the node
extra.supp_id:
string
Any ID you wish to register to the node
is_active:
boolean
If the node is indexed or marked deleted.

Examples


Result Format


Documentation

[block:api-header] {} [/block] ## Deposit Account types [block:parameters] { "data": { "h-0": "Type", "h-1": "Default Permissions", "h-2": "Comment", "0-0": "DEPOSIT-US", "0-1": "CREDIT-AND-DEBIT", "0-2": "A Synapse node that allows any user to hold funds. You can use this node as a wallet, an escrow account, etc.", "1-0": "SUBACCOUNT-US", "1-1": "CREDIT-AND-DEBIT", "1-2": "A subaccount inside an FBO account.", "2-0": "RESERVE-US", "2-1": "CREDIT", "2-2": "A Synapse node that allows any user to hold funds. You can use this node for storing reserves with Synapse.", "3-0": "SYNAPSE-US", "3-1": "CREDIT-AND-DEBIT", "3-2": "**[Deprecated]** A Synapse node that allows any user to hold funds. You can use this node as a wallet, an escrow account, etc.", "4-0": "TRIUMPH-SUBACCOUNT-US", "4-1": "CREDIT-AND-DEBIT", "4-2": "**[Deprecated]** A subaccount inside a FBO account at Triumph Bank." }, "cols": 3, "rows": 5 } [/block]