View Sub-Account

Get subaccount details

user_id :
required
string

The user ID of the user

node_id :
required
string

The node ID of the node

QUERY PARAMETER

full_dehydrate :
string no

[yes/no] Full Dehydrate yes will return back all the node info including decrypted account/routing number, transaction history, etc.

EXAMPLE REQUEST

GET /v3.1/users/5bc305abd83c197a45848f88/nodes/5bd18a08f9bd8600bea124be HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_cJokUnXuK428GhZESHPMfltOQ0Crv1eF93yBxDa0|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
subaccount_node_id = "5bd18a08f9bd8600bea124be"
node = user.get_node(subaccount_node_id, full_dehydrate=True, force_refresh=True)
const subaccountNodeID = '5bd18a08f9bd8600bea124be';

user.getNode(subaccountNodeID);
node_id= “5bd18a08f9bd8600bea124be”
user.get_user_node(node_id: node_id)
$nodeid = '5c6468aa7b08ab8e4fe658d9';
$full_dehydrate=null;
$force_refresh = null;
$user->get_node($nodeid, $full_dehydrate, $force_refresh);
data, err := user.GetNode(“5bd18a08f9bd8600bea124be”)

EXAMPLE RESPONSE

{
    "_id": "5bd18a08f9bd8600bea124be",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5bc305abd83c197a45848f88/nodes/5bd18a08f9bd8600bea124be"
        }
    },
    "allowed": "CREDIT-AND-DEBIT",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "extra": {
        "note": null,
        "other": {},
        "supp_id": ""
    },
    "info": {
        "balance": {
            "amount": 0,
            "currency": "USD"
        },
        "document_id": "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8",
        "monthly_withdrawals_remaining": null,
        "name_on_account": " ",
        "nickname": "My Sub-Account"
    },
    "is_active": true,
    "timeline": [
        {
            "date": 1540459015761,
            "note": "Node created."
        }
    ],
    "type": "SUBACCOUNT-US",
    "user_id": "5bc305abd83c197a45848f88"
}

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of nodes.

Things to Monitor:

  • Negative Balances: Balances can go negative due to returns, chargebacks and offline authorization for cards. When this happens, please prompt the user to fund their account. Please be aware that we reconcile open negative balances from your reserve account once a month during billing.

  • Low Balances: If you need this account to maintain a minimum balance, you can monitor the balance and send automatic reminders to your users to fund the account when it needs to be topped up.

  • Account Status: Webhooks will alert you when a sub-account’s status changes. This is helpful if a user’s sub-account is locked or updated.

View Sub-Account


Get subaccount details

Suggested Edits are limited on API Reference Pages

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