View All User Nodes

user_id :
required
string

ID of user

QUERY PARAMETER

page :
integer

Page number

per_page :
integer 20

Number of nodes per page

type :
string

Type of nodes you wish to see. SYNAPSE-US, ACH-US, etc.

EXAMPLE REQUEST

GET /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
user.get_all_nodes(page=4, per_page=10, type='DEPOSIT-US')
user.getAllUserNodes();
user.get_all_nodes()
$page = 1;
$per_page = 1;
$type = 'DEPOSIT-US';

$user->get_all_nodes($page , $per_page , $type);
data, err := user.GetNodes()

EXAMPLE RESPONSE

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 5,
    "nodes": [
        {
            "_id": "594e5c694d1d62002f17e3dc",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/594e0fa2838454002ea317a0/nodes/594e5c694d1d62002f17e3dc"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFI"
            },
            "extra": {
                "other": {},
                "supp_id": "ABC124"
            },
            "info": {
                "account_num": "7443",
                "address": "PLACE DE LA REPUBLIQUE 4 CROIX 59170 FR",
                "balance": {
                    "amount": "0.00",
                    "currency": "USD"
                },
                "bank_long_name": "3 SUISSES INTERNATIONAL",
                "bank_name": "3 SUISSES INTERNATIONAL",
                "name_on_account": " ",
                "nickname": "Some Account"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1498307689471,
                    "note": "Node created."
                },
                {
                    "date": 1498307690130,
                    "note": "Unable to send micro deposits as node type is not ACH-US."
                }
            ],
            "type": "WIRE-INT",
            "user_id": "594e0fa2838454002ea317a0"
        },
        {
        	...
        },
        {
        	...
        },
        ...
    ],
    "page": 1,
    "page_count": 1,
    "success": true
}

PAGINATION

Responses are paginated, so to move through pages, add page as a GET parameter. Here is an example request.

GET /v3.1/users/594e0fa2838454002ea317a0/nodes?page=2 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

View All User Nodes


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.