Link with Account/Routing

POST an ACH-US node with Account/Routing

After you Create a User and OAuth the User, you are ready to link a bank account.

To link any US bank without bank logins, manually submit the account/routing number. By default you will receive CREDIT only permissions. To receive CREDIT-AND-DEBIT permissions, verify the account with micro-deposits. Please be aware that it will take 1-2 business days for the micro-deposits to show up in the user's account.

Currently the balance amount will stay as 0 in the response body. This means sending money to and from the ACH-US node will not change the balance. This is specific for ACH-US nodes linked with Account/Routing.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes

PATH PARAMETER

Path Params

user_id :
required
string

The user ID of the user you wish to add the ACH-US node under

BODY PARAMETER

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, SAVINGS, GENERAL_LEDGER or LOAN

extra.supp_id :
string

Any ID you wish to register to the node

extra.note :
string

Memo tagged with the node

extra.other :
object

Supply data to skip micro-deposits. Note: Your platform has to be enabled for this.

is_active :
boolean

If the node is indexed or marked deleted.

EXAMPLE REQUEST

POST /v3.1/users/594e0fa2838454002ea317a0/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_auVIbQ8WXC0pnLU9ivEs4tcHDejqFJlwoNrZ3fO1|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "type": "ACH-US",
  "info": {
    "nickname": "Fake Account",
    "account_num": "1232225674134",
    "routing_num": "051000017",
    "type": "PERSONAL",
    "class": "CHECKING"
  }
}
body = {
  "type": "ACH-US",
  "info": {
    "nickname": "Fake Account",
    "account_num": "1232225674134",
    "routing_num": "051000017",
    "type": "PERSONAL",
    "class": "CHECKING"
  }
}

user.create_node(body)
const body = {
  "type": "ACH-US",
  "info": {
    "nickname": "Fake Account",
    "account_num": "1232225674134",
    "routing_num": "051000017",
    "type": "PERSONAL",
    "class": "CHECKING"
  }
}

user.createNode(body);
body = {
  "type": "ACH-US",
  "info": {
    "nickname": "Fake Account",
    "account_num": "1232225674134",
    "routing_num": "051000017",
    "type": "PERSONAL",
    "class": "CHECKING"
  }
}

user.create_node(payload: body)
$infoachus = (object)[
 "nickname" => "Fake Account",
 "account_num" => "1232225674134",
 "routing_num" => "051000017",
 "type" => "PERSONAL",
 "class" => "CHECKING"
];
$body = (object) [
 "type" => "ACH-US",
 "info" => $infoachus
];

$user->create_node($body);
body = `{
  "type": "ACH-US",
  "info": {
    "nickname": "Fake Account",
    "account_num": "1232225674134",
    "routing_num": "051000017",
    "type": "PERSONAL",
    "class": "CHECKING"
  }
}`

data, err := user.CreateNode(body)

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "594e21fc4d1d62002f17e37d",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e21fc4d1d62002f17e37d"
                }
            },
            "allowed": "CREDIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "other": {},
                "supp_id": "ABC124"
            },
            "info": {
                "account_num": "4134",
                "address": "8001 VILLA PARK DRIVE, HENRICO, VA, US",
                "balance": {
                    "amount": "0.00",
                    "currency": "USD"
                },
                "bank_long_name": "BANK OF AMERICA",
                "bank_name": "BANK OF AMERICA",
                "class": "CHECKING",
                "match_info": {
                    "email_match": "not_found",
                    "name_match": "not_found",
                    "phonenumber_match": "not_found"
                },
                "name_on_account": " ",
                "nickname": "Fake Account",
                "routing_num": "0017",
                "type": "PERSONAL"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1498292731835,
                    "note": "Node created."
                }
            ],
            "type": "ACH-US",
            "user_id": "594e0fa2838454002ea317a0"
        }
    ],
    "page_count": 1,
    "success": true
}

Sandbox Test Values

Account Number
Routing Number

Any Number between 5-25 digits
*Please do not submit real account numbers in sandbox

Any Valid Routing Number

Next Step: Micro-Deposit Verification

To receive CREDIT-AND-DEBIT permissions, verify the account with Micro-Deposits.

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of nodes.