Open Sub-Account Account

POST Node to open a subaccount (SUBACCOUNT-US) within the platform's FBO account

Previous Step: Create User and OAuth User.

API Endpoint

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

PATH PARAMETER

user_id:
required
string

Object ID of the user an account is being created for

BODY PARAMETER

type:
required
string

Type of node. This should be SUBACCOUNT-US

info.nickname:
required
string

Nickname associated with the node

info.document_id:
required
string

Base document id of the user.

extra.supp_id:
string

Any Id you wish to register to the node

is_active:
boolean

If the node is indexed or marked deleted

TIP: After the account is created, save the node ID _id, as it will be referenced when creating transactions.

Example Request

POST /v3.1/users/5ba52ec00abfb200a8a93e90/nodes HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_wBvo8QzEDZVkTWtG2yX6rn0dgRfJN1P0UjILxq4K|123456789
Content-Type: application/json

{
  "type": "SUBACCOUNT-US",
  "info": {
    "nickname":"My Sub-Account",
   
 "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}
body=  {
  "type": "SUBACCOUNT-US",
  "info": {
    "nickname":"My Sub-Account"
  }
}

user.create_node(body, idempotency_key='123456')
const body =  {
  "type": "SUBACCOUNT-US",
  "info": {
    "nickname":"My Sub-Account"
  }
};

user.createNode(body);
body=  {
  "type": "SUBACCOUNT-US",
  "info": {
    "nickname":"My Sub-Account"
  }
}

user.create_node(payload: body)
$info= (object) [
   "nickname" => "My Sub Account",
   "document_id" => "2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
];
$body = (object) [
   'type' => 'SUBACCOUNT-US',
   'info' => $info
];

$user->create_node($body);
body := `{
  "type": "SUBACCOUNT-US",
  "info": {
    "nickname":"My Sub-Account",
        "document_id":"2a4a5957a3a62aaac1a0dd0edcae96ea2cdee688ec6337b20745eed8869e3ac8"
  }
}`

data, err := user.CreateNode(body)

Example Successful 200 Response

{
    "error_code": "0",
    "http_code": "200",
    "limit": 20,
    "node_count": 1,
    "nodes": [
        {
            "_id": "5ba98a1c4d1d6200a4736e25",
            "_links": {
                "self": {
                    "href": "https://uat-api.synapsefi.com/v3.1/users/5ba52ec00abfb200a8a93e90/nodes/5ba98a1c4d1d6200a4736e25"
                }
            },
            "allowed": "CREDIT-AND-DEBIT",
            "client": {
                "id": "5ade26b4567a900029e2afd2",
                "name": "YY Test Account"
            },
            "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": 1537837596112,
                    "note": "Node created."
                }
            ],
            "type": "SUBACCOUNT-US",
            "user_id": "5ba52ec00abfb200a8a93e90"
        }
    ],
    "page_count": 1,
    "success": true
}

Note: Close a Sub-Account
To close an account, please return funds to the user and set is_active to false and change the permissions to INACTIVE

Subscribe to Webhooks

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

Negative Balance Reconciliation

We reconcile negative balances when accounts have been negative for 30 days with no successful activity. These reconciliations occur throughout the month, and funds will be debited from your reserve account to reconcile these balances. After an account has been reconciled, the user will be locked.

For example:
If a user has a negative balance of -$500 and they pay +$400 toward that negative balance before the 30 day period is up, we will reset the 30 day countdown. If another 30 days passes and there is no successful activity, we will reconcile the remaining negative balance of -$100 from your reserve funds.

We recommend setting up webhooks to monitor your reserve account balance. This will help you automatically fund your reserve when it falls below your required minimum balance.

Please Note:
We reconcile high risk negative balances more frequently than every 30 days. This includes negative balances greater than $2000.

Open Sub-Account Account


POST Node to open a subaccount (SUBACCOUNT-US) within the platform's FBO account

Suggested Edits are limited on API Reference Pages

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