{"_id":"55ff583f948a830d0023a64a","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"},"editedParams2":true,"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"},"__v":9,"editedParams":true,"parentDoc":null,"user":"54e4044e8ef7552300409dcb","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-21T01:07:11.716Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","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\": \"ACH-US\",\n  \"info\": {\n    \"nickname\": \"Fake Account\",\n    \"account_num\": \"1232225674134\",\n    \"routing_num\": \"051000017\",\n    \"type\": \"PERSONAL\",\n    \"class\": \"CHECKING\"\n  }\n}","language":"http"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"error_code\": \"0\",\n    \"http_code\": \"200\",\n    \"limit\": 20,\n    \"node_count\": 1,\n    \"nodes\": [\n        {\n            \"_id\": \"594e21fc4d1d62002f17e37d\",\n            \"_links\": {\n                \"self\": {\n                    \"href\": \"https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e21fc4d1d62002f17e37d\"\n                }\n            },\n            \"allowed\": \"CREDIT\",\n            \"client\": {\n                \"id\": \"589acd9ecb3cd400fa75ac06\",\n                \"name\": \"SynapseFI\"\n            },\n            \"extra\": {\n                \"other\": {},\n                \"supp_id\": \"ABC124\"\n            },\n            \"info\": {\n                \"account_num\": \"4134\",\n                \"address\": \"8001 VILLA PARK DRIVE, HENRICO, VA, US\",\n                \"balance\": {\n                    \"amount\": \"0.00\",\n                    \"currency\": \"USD\"\n                },\n                \"bank_long_name\": \"BANK OF AMERICA\",\n                \"bank_name\": \"BANK OF AMERICA\",\n                \"class\": \"CHECKING\",\n                \"match_info\": {\n                    \"email_match\": \"not_found\",\n                    \"name_match\": \"not_found\",\n                    \"phonenumber_match\": \"not_found\"\n                },\n                \"name_on_account\": \" \",\n                \"nickname\": \"Fake Account\",\n                \"routing_num\": \"0017\",\n                \"type\": \"PERSONAL\"\n            },\n            \"is_active\": true,\n            \"timeline\": [\n                {\n                    \"date\": 1498292731835,\n                    \"note\": \"Node created.\"\n                }\n            ],\n            \"type\": \"ACH-US\",\n            \"user_id\": \"594e0fa2838454002ea317a0\"\n        }\n    ],\n    \"page_count\": 1,\n    \"success\": true\n}","name":""}]},"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":"55fa3f2a17b9d00d00969ea3","ref":"","in":"body","required":true,"desc":"Account number associated with the bank","default":"","type":"string","name":"info.account_num"},{"_id":"55ff577b5c67200d00fa2fc1","ref":"","in":"body","required":true,"desc":"Routing number associated with the bank","default":"","type":"string","name":"info.routing_num"},{"_id":"55ff5907748eb30d008a1ed9","ref":"","in":"body","required":true,"desc":"Type of account. `PERSONAL` or `BUSINESS`","default":"","type":"string","name":"info.type"},{"_id":"55ff5907748eb30d008a1ed8","ref":"","in":"body","required":true,"desc":"Class of account. `CHECKING` or `SAVINGS`","default":"","type":"string","name":"info.class"},{"_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":"58fe92f443708d1900c36463","ref":"","in":"path","required":true,"desc":"The user ID of the user you wish to add the ACH-US node under","default":"","type":"string","name":"user_id"},{"_id":"594e62ba57b2c60061f147ff","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":9,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"ACH-US Accounts added with this method require [Micro-deposit Verification](doc:verify-micro-deposit)  to receive `CREDIT-AND-DEBIT` permissions. \\n\\nMicro-deposits are automatically triggered after a node is added.\\n\\nDo not try to guess micro deposit amounts. Nodes lock after 5 incorrect attempts. If the user has misplaced micro-deposits, we recommend using [Reinitiate Micro-deposits](doc:reinitiate-micro-deposits) API.\",\n  \"title\": \"Micro-deposit Verification\"\n}\n[/block]","excerpt":"Create an ACH-US node using account/routing numbers","slug":"add-ach-us-node-via-acrt-s","type":"endpoint","title":"ACH-US with AC/RT"}

postACH-US with AC/RT

Create an ACH-US node using account/routing numbers

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

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

Body Params

type:
required
string
Type of node you wish to add
info.nickname:
required
string
Nickname for the node
info.account_num:
required
string
Account number associated with the bank
info.routing_num:
required
string
Routing number associated with the bank
info.type:
required
string
Type of account. `PERSONAL` or `BUSINESS`
info.class:
required
string
Class of account. `CHECKING` or `SAVINGS`
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:callout] { "type": "info", "body": "ACH-US Accounts added with this method require [Micro-deposit Verification](doc:verify-micro-deposit) to receive `CREDIT-AND-DEBIT` permissions. \n\nMicro-deposits are automatically triggered after a node is added.\n\nDo not try to guess micro deposit amounts. Nodes lock after 5 incorrect attempts. If the user has misplaced micro-deposits, we recommend using [Reinitiate Micro-deposits](doc:reinitiate-micro-deposits) API.", "title": "Micro-deposit Verification" } [/block]