View Card

Get the details on the debit card

To view a specific card number and all the details, and preferences associated with the card you can perform the API call below.

API ENDPOINT

https://uat-api.synapsefi.com/v3.1/users/:user_id/nodes/:node_id/subnets/:subnet_id

PATH PARAMETER

user_id :
required
string

ID of user

node_id :
required
string

ID of node

subnet_id :
required
string

ID of subnet

QUERY PARAMETER

full_dehydrate :
stringyes/no

[yes/no] Full Dehydrate yes will return back all the card info including the card number, and cvc.

No payload is needed for the request — but you need to pass in the subnet_id you saved when issuing the subnet.

EXAMPLE REQUEST

GET/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b?full_dehydrate=no
HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
GET/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b?full_dehydrate=yes
HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_xEyuYzmPN6Rp120Kg08Ma3SdO4w5c9ZFBnWfbJer|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id, subnet_id);
const nodeID = '594e606212e17a002f2e3251';
const subnetID = '59c9f77cd412960028b99d2b';

user.getSubnet(nodeID, subnetID);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'

user.get_subnet(node_id: node_id, subnet_id: subnet_id)
$nodeid = '594e606212e17a002f2e3251';
$subnetid = '59c9f77cd412960028b99d2b';

$user->get_subnet($nodeid, $subnetid);
nodeID := "594e606212e17a002f2e3251"
subID := "59c9f77cd412960028b99d2b"

data, err := user.GetSubnet(nodeID, subID)

EXAMPLE RESPONSE

{
    "_id": "59c9f77cd412960028b99d2b",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
        }
    },
    "access_token": "5bc920f2fff373002bf0d51b",
    "account_class": "DEBIT_CARD",
    "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
    "card_number": "5431",
    "card_style_id": "555",
    "client": {
        "id": "5b0da0f66e990e001f0c5f54",
        "name": "SynapseFI"
    },
    "cvc": "***",
    "exp": "2022-11-17",
    "nickname": "My Debit Card",
    "node_id": "59c9f6a66d7d8a002f71b191",
    "preferences": {
        "allow_foreign_transactions": true,
        "daily_atm_withdrawal_limit": 10,
        "daily_transaction_limit": 1000,
        "spending_limit": false
    },
    "status": "ACTIVE",
    "user_id": "59c9f69a89ec34002e1b4b2e"
}
{
    "_id": "59c9f77cd412960028b99d2b",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/59c9f69a89ec34002e1b4b2e/nodes/59c9f6a66d7d8a002f71b191/subnets/59c9f77cd412960028b99d2b"
        }
    },
    "access_token": "5bc920f2fff373002bf0d51b",
    "account_class": "DEBIT_CARD",
    "card_hash": "78eb685b26d99d32538feb97cfd1274f994bdde48fa75471f22ba3029cbbc4e0",
    "card_number": "4456016463575431",
    "card_style_id": "555",
    "client": {
        "id": "5b0da0f66e990e001f0c5f54",
        "name": "SynapseFI"
    },
    "cvc": "875",
    "exp": "2022-11-17",
    "nickname": "My Debit Card",
    "node_id": "59c9f6a66d7d8a002f71b191",
    "preferences": {
        "allow_foreign_transactions": true,
        "daily_atm_withdrawal_limit": 10,
        "daily_transaction_limit": 1000,
        "spending_limit": false
    },
    "status": "ACTIVE",
    "user_id": "59c9f69a89ec34002e1b4b2e"
}

PCI Considerations

Please DO NOT store card numbers. Please also review the following before displaying card information.

Web Interfaces:
If you plan to have a web version of your app, we do not recommend displaying card_number, cvc and exp date unless you are PCI compliant. This is because you will have to route this through your server, even if you are not storing card information. We recommend using our UI as a Service component for this use case, so you can redirect users there when viewing card details.

App Interfaces:
For applications, you can do the GET API call in the app itself. That way you are in full control of the UI without transmitting card data through your servers. Here is what we recommend:

  1. OAuth the user on your server, but with only scope "NODE|GET"
  2. Send this oauth_key to the user’s app
  3. Do full_dehydrate=yes from the app

Subscribe to Webhooks

We recommend that you subscribe to webhooks to stay updated on the status of nodes.

View Card


Get the details on the debit card

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.