Subnet
PATCH
https://api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id
This endpoint allows you to update a subnet.
Path Parameters
Name Type Description User's OAuth key and device fingerprint, separated by a pipe.
IP address of user's device.
Your Client ID and Secret, separated by a pipe.
200 Subnet Successfully Created. 400 Request Failing.
Copy {
"_id" : "5fe28e3e7dac291e78cb4d74" ,
"_links" : {
"self" : {
"href": "https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74"
}
} ,
"abu_token" : "5fe28e3fd50242edf01b0a5e" ,
"account_class" : "CARD" ,
"agreements" : [
{
"type" : "SUBNET_AGREEMENT" ,
"url": "https://cdn.synapsepay.com/uploads/2020/12/23/6kVEz9x2Wi7R5DcqsGZd1uOlXSKBhafH0Cbnv34ojMNYIgptJQ.pdf"
}
] ,
"card_number" : "1976" ,
"card_style_id" : null ,
"client" : {
"id" : "589acd9ecb3cd400fa75ac06" ,
"name" : "SynapseFi"
} ,
"created_on" : 1608683069618 ,
"cvc" : "***" ,
"exp" : "2024-12-22" ,
"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" : "ACTIVE" ,
"status_code" : null ,
"supp_id" : null ,
"updated_on" : 1608683075046 ,
"user_id" : "5fd7acfd8677040053ad486d"
}
Copy {
"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 node updates. Following are some examples of most common update calls:
Update Subnet Status
Go to Possible Status Values and Possible Status Codes to learn more.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"status" : "ACTIVE"
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"status":"ACTIVE"
}'
Set Card Subnet PIN
In the following example the pin is encrypted. Go to Encryption Keys for Subnet to learn more.
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"pin": "VJu4gc4mWlXdBXxtdUnZTIqjK+oEGAJAvbk822A7U3tLtwKJmdhk4WpyJaCxUBe7+LuOasnCpVlOcJbL0okopRrNN2sw4w5XEFhhJ2hbTBsWw2u7hC2SZF58W0zpzJKuWjvdandeGVMXWw17ZHZ2QRDX3jd5Yc6ndtzC2ebPPw/D0d9bOAQYEanD+PBHqI0/O0CHxEqxMobHa/iyLElnQ5/mrB01g9+WIJhOSDCIq2OH1XHSo1upX8KGScxOFOd7XuMvNocWWKP1ILrLrmAPEIRfghInCjPPdJh/9nBTVh3qrUu/3dovCNDN5nUs0ljN/6qp5VxXAI79kYq/8vtTlA=="
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"pin": "VJu4gc4mWlXdBXxtdUnZTIqjK+oEGAJAvbk822A7U3tLtwKJmdhk4WpyJaCxUBe7+LuOasnCpVlOcJbL0okopRrNN2sw4w5XEFhhJ2hbTBsWw2u7hC2SZF58W0zpzJKuWjvdandeGVMXWw17ZHZ2QRDX3jd5Yc6ndtzC2ebPPw/D0d9bOAQYEanD+PBHqI0/O0CHxEqxMobHa/iyLElnQ5/mrB01g9+WIJhOSDCIq2OH1XHSo1upX8KGScxOFOd7XuMvNocWWKP1ILrLrmAPEIRfghInCjPPdJh/9nBTVh3qrUu/3dovCNDN5nUs0ljN/6qp5VxXAI79kYq/8vtTlA=="
}'
Set Card Subnet Preferences
Note: When patching subnet preferences, use USD amounts. When viewing the subnet object using a GET call, the amounts will be shown in cUSD (cents).
HTTP cURL Python JS PHP GO
Copy PATCH /v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74 HTTP / 1.1
Host : uat-api.synapsefi.com
X-SP-USER-IP : 255.127.79.76
X-SP-USER : oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type : application/json
{
"preferences" : {
"allow_foreign_transactions" : false ,
"daily_transaction_limit" : 2000 ,
"daily_cash_limit" : 500
}
}
Copy curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/nodes/5fd901bb20b3aa0bc7caee85/subnets/5fe28e3e7dac291e78cb4d74' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_A0GrzQJKInyljsCtNV37MbeF4ZTYxau9o1WSkdpq|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
"preferences": {
"allow_foreign_transactions":false,
"daily_transaction_limit":99,
"daily_cash_limit":99.99
}
}'