{"__v":5,"_id":"55ff5695cc468e0d008dce67","category":{"__v":16,"_id":"55fca6bf34ae7c0d00ab8ea0","pages":["55ff4f549f5a880d00a6c32b","55ff52fa9f5a880d00a6c32d","55ff54365c67200d00fa2fb6","55ff57305c67200d00fa2fc0","55ff583f948a830d0023a64a","55ff5a11948a830d0023a659","55ff6162feaf310d007dd66a","55ff62289e7ccf0d000a1d7a","55ff6455feaf310d007dd66b","55ff71436932a00d00ba7a3b","55ff814c8c0c9d0d00dcac33","55ff81ecfeaf310d007dd67f","55ff890a8c0c9d0d00dcac51","55ff89778c0c9d0d00dcac52","55ff8e50feaf310d007dd68d","55ff8edd0e2b090d00863365"],"project":"54e405191e51932d006abc39","version":"55fa37c88065a10d004e5bb6","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T00:05:19.904Z","from_sync":false,"order":3,"slug":"nodes","title":"Nodes"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","version":{"__v":7,"_id":"55fa37c88065a10d004e5bb6","project":"54e405191e51932d006abc39","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"REST V3","version_clean":"3.1.0","version":"3.1"},"updates":["5705ae4321cfed0e00e8c57e"],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T01:00:05.677Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: oauth_40e63a68ef9a11e6834f0a81c1ab804f|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -H \"Content-Type: application/json\" -d '{\n  \"type\": \"SYNAPSE-US\",\n  \"info\":{\n      \"nickname\":\"My Checking\"\n  },\n  \"extra\": {\n    \"supp_id\": \"123456\"\n  },\n  \"is_active\": true\n}' \"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9/nodes\"","name":""}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\n            \"_id\": \"589dcbf5ab6ce700207f89f6\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/589dc8817562960020cb00c9/nodes/589dcbf5ab6ce700207f89f6\"\n                }\n            },\n            \"allowed\": \"CREDIT-AND-DEBIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"supp_id\": \"123456\"\n            },\n            \"info\": {\n                \"balance\": {\n                    \"amount\": \"0.00\",\n                    \"currency\": \"USD\"\n                },\n                \"name_on_account\": \"********\",\n                \"nickname\": \"My Checking\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1486736373120,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"SYNAPSE-US\",\n            \"user_id\": \"589dc8817562960020cb00c9\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","language":"json","status":200}]},"settings":"","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":"57045a9b211f330e0084a5a6","ref":"","in":"body","required":false,"desc":"Mark as true if this node should just send and receive funds via your gateway transactions. Please do not use this flag without talking to us first.","default":"","type":"boolean","name":"extra.gateway_restricted"},{"_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"}],"url":"/users/:user_id/nodes"},"isReference":true,"order":10,"body":"","excerpt":"","slug":"add-synapse-us-node","type":"endpoint","title":"SYNAPSE-US"}

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
extra.gateway_restricted:
boolean
Mark as true if this node should just send and receive funds via your gateway transactions. Please do not use this flag without talking to us first.

Examples


Result Format