Create Subnet

post
Subnets

https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets
This endpoint allows you to create a subnet.
Request
Response
Request
Path Parameters
node_id
required
string
ID of the node.
user_id
required
string
ID of the user.
Headers
X-SP-USER
required
string
User's OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP
required
string
IP address of user's device.
X-SP-GATEWAY
optional
string
Your Client ID and Secret, separated by a pipe.
Response
200: OK
Subnet Successfully Created.
{
"_id": "5fdaa7d0d608d8b2ea80a6e4",
"_links": {
"self": {
"href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fdaa7d0d608d8b2ea80a6e4"
}
},
"account_class": "CHECKING",
"account_num": "9826994713",
"agreements": [],
"client": {
"id": "589acd9ecb3cd400fa75ac06",
"name": "SynapseFi"
},
"created_on": 1608165328800,
"nickname": "Test AC/RT",
"node_id": "5fd901bb20b3aa0bc7caee85",
"routing_num": {
"ach": "084106768",
"wire": "084106768"
},
"status": "ACTIVE",
"status_code": null,
"supp_id": null,
"updated_on": 1608165328806,
"user_id": "5fd7acfd8677040053ad486d"
}
400: Bad Request
Request Failing.
{
"error": {
"code": "missing_user_credentials",
"en": "User credentials are missing from the request."
},
"error_code": "200",
"http_code": "400",
"success": false
}

Go to Subnet Object Details to see all the required and optional body parameters allowed during subnet creation. Following are a few examples of various subnets and how to create them:

Issue Account Number

We require that you first generate a preview of the subnet agreement, display it to the user to get their consent and then create the subnet. To generate a preview, add "preview_only":true to the payload.

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets 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
{
"nickname":"Test AC/RT"
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'
--data-raw '{
"nickname":"Test AC/RT"
}'
Python
//
JS
//
PHP
//
GO
//

Issue Card

We require that you first generate a preview of the subnet agreement, display it to the user to get their consent and then create the subnet. To generate a preview, add "preview_only":true to the payload.

HTTP
cURL
Python
JS
PHP
GO
HTTP
POST /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets 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
{
"nickname":"My Debit Card",
"account_class":"CARD"
}
cURL
curl --location --request POST 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_0YFNLHvg2c0mjGopszQ45yOBiqSUl8xruCRfaZXw|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"nickname":"My Debit Card",
"account_class":"CARD"
}'
Python
//
JS
//
PHP
//
GO
//