{"__v":4,"_id":"55ff57305c67200d00fa2fc0","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":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T01:02:40.564Z","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\": \"ACH-US\",\n  \"info\":{\n    \"bank_id\":\"synapse_nomfa\",\n    \"bank_pw\":\"test1234\",\n    \"bank_name\":\"fake\"\n  }\n}' \"https://sandbox.synapsepay.com/api/3/users/589dc8817562960020cb00c9/nodes\"","name":""}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 2,\n    \"node_count\": 2,\n    \"nodes\": [\n        {\n            \"_id\": \"589dcb0e7e0887001e94048d\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/589dc8817562960020cb00c9/nodes/589dcb0e7e0887001e94048d\"\n                }\n            },\n            \"allowed\": \"CREDIT-AND-DEBIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"supp_id\": \"\"\n            },\n            \"info\": {\n                \"account_num\": \"8902\",\n                \"address\": \"PO BOX 85139, RICHMOND, VA, US\",\n                \"balance\": {\n                    \"amount\": \"0.00\",\n                    \"currency\": \"USD\"\n                },\n                \"bank_long_name\": \"CAPITAL ONE N.A.\",\n                \"bank_name\": \"CAPITAL ONE N.A.\",\n                \"class\": \"SAVINGS\",\n                \"match_info\": {\n                    \"email_match\": \"no_match\",\n                    \"name_match\": \"no_match\",\n                    \"phonenumber_match\": \"no_match\"\n                },\n                \"name_on_account\": \"********\",\n                \"nickname\": \"SynapsePay Test Savings Account - 8902\",\n                \"routing_num\": \"6110\",\n                \"type\": \"BUSINESS\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1486736190770,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"ACH-US\",\n            \"user_id\": \"589dc8817562960020cb00c9\"\n        },\n        {\n            ...\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":""},{"status":202,"language":"json","code":"{\n    \"error_code\": \"10\",\n    \"http_code\": \"202\",\n    \"mfa\": {\n        \"access_token\": \"793ef2556efe00d5799706cf8801f0a1ecb051e0293f2224b54db06f9c84e3a6\",\n        \"message\": \"I heard you like questions so we put a question in your question?\",\n        \"type\": \"question\"\n    },\n    \"success\": true\n}"}]},"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":"Online banking's username","default":"","type":"string","name":"info.bank_id"},{"_id":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":true,"desc":"Online banking's password","default":"","type":"string","name":"info.bank_pw"},{"_id":"55ff577b5c67200d00fa2fc1","ref":"","in":"body","required":true,"desc":"Bank's name","default":"","type":"string","name":"info.bank_name"}],"url":"/users/:user_id/nodes"},"isReference":true,"order":7,"body":"[block:embed]\n{}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"These accounts may require [MFA verification](https://docs.synapsepay.com/docs/add-ach-us-node-via-bank-logins-mfa) once or _multiple_ times.\",\n  \"title\": \"Bank Login MFA\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The response may contain multiple ACH-US nodes, as shown in the example. The response returns all nodes that the user has under that bank login.\",\n  \"title\": \"Be Prepared to Receive Multiple Nodes\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"ACH-US Accounts added with Online Banking Logins are for consumer accounts only. For a full list of banks supported by online logins, visit: https://synapsepay.com/api/v3/institutions/show.\",\n  \"title\": \"Supported Institutions\"\n}\n[/block]","excerpt":"","slug":"add-ach-us-node","type":"endpoint","title":"ACH-US with Logins"}

postACH-US with Logins


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

type:
required
string
Type of node you wish to add
info.bank_id:
required
string
Online banking's username
info.bank_pw:
required
string
Online banking's password
info.bank_name:
required
string
Bank's name

Examples


Result Format


Documentation

[block:embed] {} [/block] [block:callout] { "type": "warning", "body": "These accounts may require [MFA verification](https://docs.synapsepay.com/docs/add-ach-us-node-via-bank-logins-mfa) once or _multiple_ times.", "title": "Bank Login MFA" } [/block] [block:callout] { "type": "info", "body": "The response may contain multiple ACH-US nodes, as shown in the example. The response returns all nodes that the user has under that bank login.", "title": "Be Prepared to Receive Multiple Nodes" } [/block] [block:callout] { "type": "info", "body": "ACH-US Accounts added with Online Banking Logins are for consumer accounts only. For a full list of banks supported by online logins, visit: https://synapsepay.com/api/v3/institutions/show.", "title": "Supported Institutions" } [/block]