Update Subnet Status

Change account status

This call allows you to change the status of your subnets. If you feel your account and routing numbers have been compromised in any way, please deactivate your subnets. This call should also be used if you want to no longer utilize the currently issued subnet with your Synapse accounts.

Important Note: Once subnets are terminated, this change cannot be reversed. We advise you to use this only when you are sure the numbers will not be needed again. Once a subnet is terminated, go ahead and create a new subnet to issue new account and routing numbers for your account.

API ENDPOINT

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

PATH PARAMETER

user_id :
required
string

ID of user

node_id :
required
string

ID of node

subnet_id :
required
string

ID of subnet

BODY PARAMETER

status :
required
string

Denotes the subnet standing. You can only set status to ACTIVE, INACTIVE, and TERMINATED

EXAMPLE REQUEST

PATCH /v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
  "status":"INACTIVE"
}
node_id = '594e606212e17a002f2e3251'
subn_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"INACTIVE"
}

user.update_subnet(node_id, subn_id, body)
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';
const body = {
  "status":"INACTIVE"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"INACTIVE"
}

user.update_subnet(node_id: node_id, payload: body, subnter_id: subnet_id)
$body= (object) [
  "status":"INACTIVE"
];

$node_id = '594e606212e17a002f2e3251';
$subnet_id = '59c9f77cd412960028b99d2b';
$user->update_subnet( $node_id, $subnet_id ,$body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status":"INACTIVE"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)

EXAMPLE RESPONSE

{
    "_id": "59c9f77cd412960028b99d2b",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
        }
    },
    "account_class": "CHECKING",
    "account_num": "692069247603874",
    "client": {
        "id": "589acd9ecb3cd400fa75ac06",
        "name": "SynapseFI"
    },
    "nickname": "Test AC/RT",
    "node_id": "59c9f6a66d7d8a002f71b191",
    "routing_num": {
        "ach": "084106768",
        "wire": "084106768"
    },
  	"status": "INACTIVE",
    "user_id": "59c9f69a89ec34002e1b4b2e"
}

Update Subnet Status


Change account status

Suggested Edits are limited on API Reference Pages

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