LogoLogo
StatusChangelogDashboardCreate a Ticket
  • Getting Started
  • Intro to APIs
  • How to Contact us
  • How to Go-Live
  • Intro to Risk
  • Intro to Spec Sheets
  • Product Guides
    • Deposit Hub
      • 🌎Global Cash
    • Credit Hub
    • Payment Accounts
    • ID Score
  • API References
    • OAuth
      • OAuth Object Details
      • Create OAuth Key
      • Generate Refresh Token
    • Users
      • User Object Details
      • Testing on UAT
      • View All Users
      • View User
      • Create User
      • Update User
      • Generate UBO Doc
      • Manage Duplicates
      • Allowed Document Types
      • Allowed Entity Scopes
      • Allowed Entity Types
    • Nodes
      • Node Object Details
      • Testing on UAT
      • View all User Nodes
      • View Node
      • Create Node
      • Update Node
      • Generate eCash Barcode
      • Allowed Node Types
      • View ATMs
    • Subnets
      • Subnet Object Details
      • Testing on UAT
      • View all Node Subnets
      • View Subnet
      • Create Subnet
      • Update Subnet
      • Push to Wallet
    • Shipments
      • Shipment Object Details
      • View all Subnet Shipments
      • View Shipment
      • Create Shipment
      • Cancel Shipment
    • Statements
      • Statement Object Details
      • View all User Statements
      • View all Node Statements
    • Transactions
      • Transaction Object Details
      • Testing on UAT
      • View all User Transactions
      • View all Node Transactions
      • View Transaction
      • Create Transaction
      • Create Batch Transactions
      • Cancel Transaction
      • Retry ACH Transaction
      • Dispute Chargebacks
      • Dispute Transaction
    • Subscriptions
      • Subscription Object Details
      • Webhook Object Details
      • Testing on UAT
      • View all Subscriptions
      • View Subscription
      • Create Subscription
      • Update Subscription
      • View Webhook Logs
    • Miscellaneous
      • Dummy Transactions
      • Verify Address
      • Verify Routing Number
      • International WIRE-INT Required Data by Country
      • View Billers
      • View Enriched Data
      • Loan Limits
      • Transaction Decisioning
      • 3D Secure
      • Virtual Terminal
      • Pre-Authorization
      • Card Disputes Guide
      • Mobile Wallets
      • Interchange Revenue
      • Enrichment Guide
  • Developer Guides
    • User Onboarding
      • Create User Flow
      • Authenticate as the User
      • Create Node Flow
        • Cash Advance
        • Credit Builder Loan
        • One Time Loans
        • Secured Open Loans
        • Secured Revolving Loans
        • Unsecured Revolving Loans
      • Create Subnets Flow
        • Creating Cards
        • Creating AC/RT
      • Linking External Accounts
        • Linking Cards
        • Linking External Bank Account
      • Add Additional Documents
    • Account Details
      • Displaying Balances
      • Transaction History
      • Transaction Details
      • Account Agreements
      • Node Statements
      • Card Details
    • Managing Cards
      • Card Preferences
      • Setting PIN
      • Mobile Wallet Flow
        • Integrate with Apple Pay
        • Integrate with Google Pay
        • Integrate with Samsung Pay
      • Shipping Cards
    • Originating Transactions
      • Sending Fed Wires
      • Sending ACH Transfers
      • Sending International Wires
      • Deposit a Check
      • Issuing Checks
      • Recurring Transactions
      • 3rd Party Payment Accounts
      • Cancelling Transactions
      • Exceeding Origination Limits
    • Receiving Transactions
      • Transaction Decisioning
      • Receiving ACH / Wires
      • Card Transactions
      • Exceeding Inbound Limits
    • Managing Disputes
      • ACH Disputes
      • Card Disputes
    • 3rd Party Integrations
      • Payment Integrations
      • Account Aggregators
      • 3rd Parties & Compliance
  • Recipes
    • Overdraft Protection
    • Social Banking
    • Monetizing Transactions
Powered by GitBook
On this page
  • Subnet
  • Update Subnet Status
  • Set Card Subnet PIN
  • Set Card Subnet Preferences

Was this helpful?

Export as PDF
  1. API References
  2. Subnets

Update Subnet

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

subnet_id

string

ID of the subnet.

node_id

string

ID of the node.

user_id

string

ID of the user.

Headers

Name
Type
Description

X-SP-USER

string

User's OAuth key and device fingerprint, separated by a pipe.

X-SP-USER-IP

string

IP address of user's device.

X-SP-GATEWAY

string

Your Client ID and Secret, separated by a pipe.

{
    "_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"
}
{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Update Subnet Status

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"
}
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

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=="
}
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).

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
	}
}
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
	}
}'
//
//
//
//
PreviousCreate SubnetNextPush to Wallet

Last updated 3 years ago

Was this helpful?

Go to to see all the required and optional body parameters allowed during node updates. Following are some examples of most common update calls:

Go to and to learn more.

In the following example the pin is encrypted. Go to to learn more.

Subnet Object Details
Possible Status Values
Possible Status Codes
Encryption Keys for Subnet