LogoLogo
StatusChangelogDashboardCreate a Ticket
  • Getting Started
  • Intro to APIs
  • How to Contact us
  • How to Go-Live
  • Intro to Risk
  • Intro to Spec Sheets
  • Product Guides
    • Deposit Hub
      • 🌎Global Cash
    • Credit Hub
    • Payment Accounts
    • ID Score
  • API References
    • OAuth
      • OAuth Object Details
      • Create OAuth Key
      • Generate Refresh Token
    • Users
      • User Object Details
      • Testing on UAT
      • View All Users
      • View User
      • Create User
      • Update User
      • Generate UBO Doc
      • Manage Duplicates
      • Allowed Document Types
      • Allowed Entity Scopes
      • Allowed Entity Types
    • Nodes
      • Node Object Details
      • Testing on UAT
      • View all User Nodes
      • View Node
      • Create Node
      • Update Node
      • Generate eCash Barcode
      • Allowed Node Types
      • View ATMs
    • Subnets
      • Subnet Object Details
      • Testing on UAT
      • View all Node Subnets
      • View Subnet
      • Create Subnet
      • Update Subnet
      • Push to Wallet
    • Shipments
      • Shipment Object Details
      • View all Subnet Shipments
      • View Shipment
      • Create Shipment
      • Cancel Shipment
    • Statements
      • Statement Object Details
      • View all User Statements
      • View all Node Statements
    • Transactions
      • Transaction Object Details
      • Testing on UAT
      • View all User Transactions
      • View all Node Transactions
      • View Transaction
      • Create Transaction
      • Create Batch Transactions
      • Cancel Transaction
      • Retry ACH Transaction
      • Dispute Chargebacks
      • Dispute Transaction
    • Subscriptions
      • Subscription Object Details
      • Webhook Object Details
      • Testing on UAT
      • View all Subscriptions
      • View Subscription
      • Create Subscription
      • Update Subscription
      • View Webhook Logs
    • Miscellaneous
      • Dummy Transactions
      • Verify Address
      • Verify Routing Number
      • International WIRE-INT Required Data by Country
      • View Billers
      • View Enriched Data
      • Loan Limits
      • Transaction Decisioning
      • 3D Secure
      • Virtual Terminal
      • Pre-Authorization
      • Card Disputes Guide
      • Mobile Wallets
      • Interchange Revenue
      • Enrichment Guide
  • Developer Guides
    • User Onboarding
      • Create User Flow
      • Authenticate as the User
      • Create Node Flow
        • Cash Advance
        • Credit Builder Loan
        • One Time Loans
        • Secured Open Loans
        • Secured Revolving Loans
        • Unsecured Revolving Loans
      • Create Subnets Flow
        • Creating Cards
        • Creating AC/RT
      • Linking External Accounts
        • Linking Cards
        • Linking External Bank Account
      • Add Additional Documents
    • Account Details
      • Displaying Balances
      • Transaction History
      • Transaction Details
      • Account Agreements
      • Node Statements
      • Card Details
    • Managing Cards
      • Card Preferences
      • Setting PIN
      • Mobile Wallet Flow
        • Integrate with Apple Pay
        • Integrate with Google Pay
        • Integrate with Samsung Pay
      • Shipping Cards
    • Originating Transactions
      • Sending Fed Wires
      • Sending ACH Transfers
      • Sending International Wires
      • Deposit a Check
      • Issuing Checks
      • Recurring Transactions
      • 3rd Party Payment Accounts
      • Cancelling Transactions
      • Exceeding Origination Limits
    • Receiving Transactions
      • Transaction Decisioning
      • Receiving ACH / Wires
      • Card Transactions
      • Exceeding Inbound Limits
    • Managing Disputes
      • ACH Disputes
      • Card Disputes
    • 3rd Party Integrations
      • Payment Integrations
      • Account Aggregators
      • 3rd Parties & Compliance
  • Recipes
    • Overdraft Protection
    • Social Banking
    • Monetizing Transactions
Powered by GitBook
On this page
  • Get Nodes
  • Example Request

Was this helpful?

Export as PDF
  1. API References
  2. Nodes

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.

{
    "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
}
{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

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 --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'
//
//
//
//
PreviousTesting on UATNextView Node

Last updated 4 years ago

Was this helpful?