View Subnet

Subnet

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

This endpoint allows you to get a specific subnet document.

Path Parameters

Name	Type	Description
subnet_id	string	ID of the subnet.
node_id	string	ID of the node.
user_id	string	ID of the user.

Query Parameters

Name	Type	Description
full_dehydrate	string	Set to YES if you wish to receive all subnet PII in the response. Default is NO.

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 your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 Subnet successfully retrieved.

Full Dehydrate = NO

{
    "_id": "5fdaa7d56387987e63f30d9e",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d56387987e63f30d9e"
        }
    },
    "abu_token": "5fdaa7d6e4428eb1b8b13c25",
    "account_class": "CARD",
    "agreements": [
        {
            "type": "SUBNET_AGREEMENT",
            "url": "https://cdn.synapsepay.com/uploads/2020/12/17/dF2fpTiX1uq9bOmVSYw3HM6NgeorP4zkUZA0JE7hQay08GLWIl.pdf"
        }
    ],
    "card_number": "6707",
    "card_style_id": null,
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "created_on": 1608165332508,
    "cvc": "***",
    "exp": "2024-12-16",
    "nickname": "My Debit Card",
    "node_id": "5fd901bb20b3aa0bc7caee85",
    "preferences": {
        "allow_cash_transactions": true,
        "allow_foreign_transactions": false,
        "daily_cash_limit": 100.0,
        "daily_transaction_limit": 1000.0
    },
    "status": "INACTIVE",
    "status_code": "USER_REQUESTED",
    "supp_id": null,
    "updated_on": 1608165334534,
    "user_id": "5fd7acfd8677040053ad486d"
}

Full Dehydrate = YES

{
    "_id": "5fdaa7d56387987e63f30d9e",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d56387987e63f30d9e"
        }
    },
    "abu_token": "5fdaa7d6e4428eb1b8b13c25",
    "account_class": "CARD",
    "agreements": [
        {
            "type": "SUBNET_AGREEMENT",
            "url": "https://cdn.synapsepay.com/uploads/2020/12/17/dF2fpTiX1uq9bOmVSYw3HM6NgeorP4zkUZA0JE7hQay08GLWIl.pdf"
        }
    ],
    "card_number": "5119130013186707",
    "card_style_id": null,
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFi"
    },
    "created_on": 1608165332508,
    "cvc": "273",
    "exp": "2024-12-16",
    "nickname": "My Debit Card",
    "node_id": "5fd901bb20b3aa0bc7caee85",
    "preferences": {
        "allow_cash_transactions": true,
        "allow_foreign_transactions": false,
        "daily_cash_limit": 100.0,
        "daily_transaction_limit": 1000.0
    },
    "status": "INACTIVE",
    "status_code": "USER_REQUESTED",
    "supp_id": null,
    "updated_on": 1608165334534,
    "user_id": "5fd7acfd8677040053ad486d",
    'tokens': [{
        'is_active': True,
        'unique_reference' : "DAPLMC00002...8deee71d8f'
        }]
    }
}

400 Query failing

{
    "error": {
        "code": "missing_user_ip",
        "en": "User IP is missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d56387987e63f30d9e HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d56387987e63f30d9e' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

//

JS

//

PHP

//

GO

//