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 Schema
  • Additional Values for Cards
  • Additional Values for Account Numbers
  • Possible Status Values
  • Possible Status Codes

Was this helpful?

Export as PDF
  1. API References
  2. Subnets

Subnet Object Details

Subnet Schema

Key

Type

Required

Description

_id

String

N.A. Included in API response.

Primary Key of the subnet object.

user_id

String

N.A. Included in API response.

ID of the user who owns this subnet.

node_id

String

N.A. Included in API response.

ID of the node who owns this subnet.

client.id

String

N.A. Included in API response.

The Primary Key that denotes your client object in our system.

client.name

String

N.A. Included in API response.

Your common name in our system.

nickname

String

Yes

Common name you wish to assign to the subnet. Eg. "Checking Account".

account_class

String

Yes

Account class of subnet. Allowed values: CHECKING, SAVINGS, CARD.

status

String

No

status_code

String

No

created_on

String

N.A. Included in API response.

Unix timestamp (in ms) value of when the subnet was created.

updated_on

String

N.A. Included in API response.

Unix timestamp (in ms) value of when the subnet was last updated.

supp_id

String

No

You can use this field to store the Primary Key of this object in your system.

agreements.type

String

N.A. Included in API response or async through webhook.

Type of agreement attached on the subnet. Possible values: SUBNET_AGREEMENT.

agreements.url

String

N.A. Included in API response or async through webhook.

The PDF URL of the appropriate agreement. Each agreement contains the IP, Timestamp and Device Fingerprint of the user at the time of subnet creation.

tokens.is_active

Boolean

No.

Current state of the linked card in the mobile wallet.

tokens.unique_reference

String or null

No.

The Mastercard unique token reference to the mobile wallet (Google Pay, Apple Pay, etc).

Additional Values for Cards

Key

Type

Required

Description

card_number

String

N.A. Included in API response.

Card number issued to the subnet.

cvc

String

N.A. Included in API response.

CVC associated with the subnet.

pin

String

No. Value not returned in the response.

exp

String

N.A. Included in API response.

Expiration date of card (in YYYY-MM-DD).

card_style_id

String

No

wallet_style_id

String

No

preferences.allow_foreign_transactions

Boolean

No

If True, foreign transactions will be enabled on card.

preferences.daily_transaction_limit

Number or null

No

Daily total transaction amount (in cents) allowed on the card. Datetime tracked in UTC.

When null, the card limits will default to your program limits.

preferences.daily_cash_limit

Number or null

No

Daily total amount in cash transactions (in cents) allowed on the card. Datetime tracked in UTC.

When null, the card limits will default to your program limits.

preferences.monthly_transaction_limit

Number or null

No

Currently in UAT Only

Monthly overall transactions allowed on the card. Datetime tracked in UTC.

When null, the card limits will default to your program limits.

preferences.monthly_cash_limit

Number or null

No

Currently in UAT Only

Monthly cash transactions allowed on the card. Datetime tracked in UTC.

When null, the card limits will default to your program limits.

Additional Values for Account Numbers

Key

Type

Required

Description

account_num

String

N.A. Included in API response.

Account number assigned to the subnet.

routing_num.wire

String

N.A. Included in API response.

Wire routing number assigned to the subnet.

routing_num.ach

String

N.A. Included in API response.

ACH routing number assigned to the subnet.

Encryption Keys for Subnet

Please use PKCS1_v1_5 padding to encrypt your data.

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0b1tpW5s6k/d7thDpmup
TlNMva9h+QQn17c0ypo2uzWM+zpj5OAXwkjz7TmmMl/Uiu1Wm7WThIcMBQ+KLzm4
590UXxSTWxzOSQXWWAEzp4YkpxICYsNHA1GpLtqdA+rGQcyx3TJkdh1+5SWRCcRJ
QikUa5wcApEs+L/NBm8AeKy/rqtDjb0BjAqZvoVPe4J2zJlPwwbxrIspuSCQmxle
bIHti97+maflGuy/9XV8aw1FhKbM5oeQxs9M0J49x1a7aqpIEuW3Z224UQwuGzRo
0vN3pP3YGS5cfFjVjlaQFX0Ezavl4G7u9G2IpmPky/A1eDWyC50K/F0NRCtYb4Uk
wwIDAQAB
-----END PUBLIC KEY-----
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApxPCzjKUcjktcu6DTVvw
WtDymXCJOdBaMCFejObzTgQVYWgaR2WgO0DJ8guAK02tB3yKHu+RjygAcI9GTrtR
MkJzgGA0iZ+QktiCS0ooH115TvIiPKDh9aQVqFNx7FFuji4c+KpSiHHzLnpxcUFB
7U7rq8GIqP3SkDPSFQAWwM+lANAJIzNRJx1I56odTZ1zSgsXtwH9SHjg34Ptdeu/
RjX759oWTcUdMmnHtpLOPe1co89dEpJ6QqPyo7IUHdnRfMiu63XgDUEzsaTQEevy
LeWj+VDH86y0uJbWu6CVMdEkBnNkTZDGiAmdeI0Q8LdinLUHX3j+5tzxj36iOQQi
NQIDAQAB
-----END PUBLIC KEY-----

Possible Status Values

Allowed

Description

INACTIVE

Currently the subnet is not active and unable to transact except for force posts.

TERMINATED

The subnet has been terminated and unable to transact except for force posts.

ACTIVE

Subnet is active and ready for use.

Possible Status Codes

Allowed Status Code

Description

Next Steps

USER_REQUESTED

User requested the allowed status change. Subnet will remain inactive upon account reopen.

No action required.

FRAUD_ALERT

Either the network, Synapse or you changed the status due to fraud concerns. Subnet will remain inactive upon account reopen.

Please ensure that the end user has been notified of this update.

ACCOUNT_CLOSED

Since the user account was being closed, the subnet was closed as well. When the user account opens, the subnet will go back to active.

Please ensure that the end user has been notified of this outcome.

ACCOUNT_LOCKED

Since the user account was locked, the subnet was locked as well. When the user account opens, the subnet will go back to active.

Please ensure that the end user has been notified of this outcome.

NOT_KNOWN

Allowed status change reason unknown. When the user account opens, the subnet will go back to active.

No next steps recommend here since legacy tag.

PreviousSubnetsNextTesting on UAT

Last updated 1 year ago

Was this helpful?

Status of the subnet. Go to to learn more.

Reason for status update. Go to to learn more.

Encrypted 4 digit card PIN. See . Some terminals will require a pin for debit transactions. Setting one is recommended.

Style ID of card. Used when a card is shipped. Go to to learn more.

Style ID of card when loaded on to a wallet. You can only set up pre approved wallet style ids like card style ids. Approved wallet style ids will be avaliable in your spec sheet. Go to to learn more.

Intro to Spec Sheets
Intro to Spec Sheets
Possible Status Values
Possible Status Codes
Encryption Keys for Subnet