View all User Nodes

Get Nodes

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

This endpoint allows you to get all nodes linked to a user.

Query Parameters

Name	Type	Description
type	string	Type of node you wish to query.
per_page	integer	Maximum documents to return per page. Default and max allowed is 20.
page	integer	Page number of the paginated request. Default is 1.

Headers

Name	Type	Description
X-SP-USER	string	User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of user's device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Users successfully retrieved.

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 3,
    "nodes": [
        {
            "_id": "5fd7e2b1039b95223d5f4fd4",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd7e2b1039b95223d5f4fd4"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "allowed_status_code": null,
            "client": {
                "id": "589acd9ecb3cd400fa75ac06",
                "name": "SynapseFi"
            },
            "extra": {
                "note": null,
                "other": {
                    "access_token": "5fd7e2af04d29a00399532f7",
                    "micro_meta": {
                        "micro_attempts": 0,
                        "micro_sent_count": 0,
                        "skip_micro": false
                    },
                    "updated_on": 1608001792000
                },
                "supp_id": ""
            },
            "info": {
                "account_num": "8902",
                "address": "P.O. BOX 85139, RICHMOND, VA, US",
                "balance": {
                    "amount": "750.00",
                    "currency": "USD",
                    "updated_on": 1608001792000
                },
                "bank_code": "capone",
                "bank_hlogo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_h.png",
                "bank_logo": "https://cdn.synapsepay.com/bank_logos_v3p1/CapitalOne360_v.png",
                "bank_long_name": "CAPITAL ONE  N A ",
                "bank_name": "CAPITAL ONE  N A ",
                "bank_url": "http://www.capitalone.com",
                "class": "SAVINGS",
                "match_info": {
                    "email_match": "match",
                    "name_match": "match",
                    "phonenumber_match": "no_match"
                },
                "name_on_account": " ",
                "nickname": "SynapsePay Test Savings Account - 8902",
                "routing_num": "0407",
                "type": "BUSINESS"
            },
            "is_active": true,
            "timeline": [
                {
                    "date": 1607983793123,
                    "note": "Node created."
                },
                {
                    "date": 1607983793993,
                    "note": "node_not_credit -- Unable to send micro deposits as node allowed is not CREDIT."
                }
            ],
            "type": "ACH-US",
            "user_id": "5fd7acfd8677040053ad486d"
        },
        {
            ...
        },
        {
            ...
        }
    ],
    "page": 1,
    "page_count": 1,
    "success": true
}

400 Query failing

{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fd7acfd8677040053ad486d/nodes?type=DEPOSIT-US&page=1&per_page=2 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes?type=DEPOSIT-US&page=1&per_page=2' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_WFecuSPqxGgU027IRAjtOf35vrNCpQZE1DYohX9y|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//