Subnet Object Details
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). |
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. | Encrypted 4 digit card PIN. See Encryption Keys for Subnet.
Some terminals will require a pin for debit transactions. Setting one is recommended. |
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 | 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 Intro to Spec Sheets to learn more. |
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. |
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. |
Please use
PKCS1_v1_5
padding to encrypt your data.Production
UAT
-----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-----
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. |
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. |
Last modified 2mo ago