{"_id":"55ff6455feaf310d007dd66b","project":"54e405191e51932d006abc39","user":"54e4044e8ef7552300409dcb","editedParams2":true,"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":"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"},"editedParams":true,"parentDoc":null,"__v":5,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T01:58:45.978Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"nodes\": [\n        {\n            \"_id\": \"573a721286c2731adf3aca07\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://sandbox.synapsepay.com/api/3/users/5739ea6386c27360899fd445/nodes/573a721286c2731adf3aca07\"\n                }\n            },\n            \"allowed\": \"CREDIT-AND-DEBIT\",\n            \"extra\": {\n                \"supp_id\": \"123sa\"\n            },\n            \"info\": {\n                \"balance\": {\n                    \"amount\": 0,\n                    \"currency\": \"GBP\"\n                },\n                \"name_on_account\": \"Test User\",\n                \"nickname\": \"GBP Node\"\n            },\n            \"is_active\": true,\n            \"type\": \"IOU\"\n        }\n    ],\n    \"success\": true\n}","language":"json","status":200,"name":""}]},"settings":"","examples":{"codes":[{"code":"curl -X POST -H \"X-SP-USER-IP: 127.0.0.1\" -H \"X-SP-USER: oauth_dc712ffaee2911e6bc5fd22ede5c1c8d|e716990e50b67a1177736960b6357524b22090ccab093d068b3d7a18dbde3f4c\" -H \"Content-Type: application/json\"  -d '{\n  \"type\": \"IOU\",\n  \"info\":{\n      \"nickname\":\"GBP Node\",\n      \"balance\":{\n          \"currency\":\"GBP\"\n      }\n    },\n  \"extra\": {\n    \"supp_id\": \"ABC124\"\n  },\n  \"is_active\": true\n}' \"https://sandbox.synapsepay.com/api/3/users/589b5bd084f2d0001ef562fc/nodes\"","name":"","language":"curl"}]},"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 for the node","default":"","type":"string","name":"info.nickname"},{"_id":"55ff64856932a00d00ba7a2d","ref":"","in":"body","required":true,"desc":"Currency of the Node","default":"","type":"string","name":"info.balance.currency"},{"_id":"55ff5907748eb30d008a1ed7","ref":"","in":"body","required":false,"desc":"Any ID you wish to register to the node","default":"","type":"string","name":"extra.supp_id"},{"_id":"58fe93d559079e190092fa4c","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the IOU node under","default":"","type":"string","name":"user_id"},{"_id":"594e68178564f2004b6b129c","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":19,"body":"","excerpt":"Create an IOU node","slug":"add-iou-node","type":"endpoint","title":"IOU"}

postIOU

Create an IOU 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 IOU node under

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname for the node
info.balance.currency:
required
string
Currency of 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