View Check Recipient

GET CHECK-US Node to View Check Recipient's Details

Use this call to check the details of the check recipient. Information to review includes the payee, payee full address and nickname.

API ENDPOINT

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

PATH PARAMETER

user_id :
required
string

The user ID of the 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. ex: CHECK-US.

EXAMPLE REQUEST

GET /v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bba74c785411800991b6037 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_UAH2bLKxpYMB5eXDRST1rQW90ohusljFtI78Pfnq|n38dj3h8NE393bv24ovoRY34kd62
Content-Type: application/json
check_node_id = 5bba74c785411800991b6037
user.get_node(check_node_id)
const checkNodeID = “5bba74c785411800991b6037”;

user.getNode(checkNodeID);
check_node_id = “5bba74c785411800991b6037”
user.get_user_node(node_id: check_node_id)
$nodeid = '5c3d416f7b08ab0066ee8cae';
$full_dehydrate=null;
$force_refresh = null;
$user->get_node($nodeid, $full_dehydrate, $force_refresh);
nodeID := “5bba74c785411800991b6037”

data, err := user.GetNode(nodeID)

EXAMPLE RESPONSE

{
    "_id": "5bba74c785411800991b6037",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5bb6ab05472e2500adffad5a/nodes/5bba74c785411800991b6037"
        }
    },
    "allowed": "CREDIT",
    "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "YY Test Account"
    },
    "extra": {
        "note": null,
        "other": {},
        "supp_id": ""
    },
    "info": {
        "name_on_account": " ",
        "nickname": "My Cell Phone Checking",
        "payee_address": {
            "address_city": "SAN FRANCISCO",
            "address_country_code": "US",
            "address_postal_code": "94105",
            "address_street": "1 MARKET ST",
            "address_subdivision": "CA"
        },
        "payee_name": "Some Name"
    },
    "is_active": true,
    "timeline": [
        {
            "date": 1538946245047,
            "note": "Node created."
        }
    ],
    "type": "CHECK-US",
    "user_id": "5bb6ab05472e2500adffad5a"
}

Subscribe to Webhooks

We recommend that you Subscribe to Webhooks to stay updated on the status of nodes.

View Check Recipient


GET CHECK-US Node to View Check Recipient's Details

Suggested Edits are limited on API Reference Pages

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