Delete Card

Use this API call to terminate the debit card

To delete the card number and all the details, and preferences associated with the card you can perform the API call below. Once the card is terminated, you will see "status": "TERMINATED" in the response.

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

EXAMPLE REQUEST

PATCH /v3.1/users/5c35270170c557005d9365f7/nodes/5c35271a51112300616fbaf6/subnets/5c35272aba1b8a002776f2d1 HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 127.0.0.1
X-SP-USER: oauth_JBUOZcuaWfXy8IV9YjPeh3zGCklsQoDptxHNwrRi|c406ca75d33293b5ffdaeb64c4d3e976111
Content-Type: application/json

{
  "status":"TERMINATED"
}
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id, subnet_id, body)
const node_id = '594e606212e17a002f2e3251';
const subnet_id = '59c9f77cd412960028b99d2b';
const body = {
  "status":"TERMINATED"
};

user.updateSubnet(nodeID, subnetID, body);
node_id = '594e606212e17a002f2e3251'
subnet_id = '59c9f77cd412960028b99d2b'
body = {
  "status":"TERMINATED"
}

user.update_subnet(node_id: node_id, payload: body, subnet_id: subnet_id)
$body= (object) [
  "status":"TERMINATED"
];

$node_id = '594e606212e17a002f2e3251';
$subnet_id = '59c9f77cd412960028b99d2b';

$user->update_subnet( $$node_id, $subnet_id ,$body);
nodeID := "59c9f6a66d7d8a002f71b191"
subnetID := "5bc920f2fff373002bf0d51b"
body := `{
  "status":"TERMINATED"
}`

data, err := user.UpdateSubnet(nodeID, subnetID, body)

EXAMPLE RESPONSE

{
    "_id": "5c35272aba1b8a002776f2d1",
    "_links": {
        "self": {
            "href": "https://uat-api.synapsefi.com/v3.1/users/5c35270170c557005d9365f7/nodes/5c35271a51112300616fbaf6/subnets/5c35272aba1b8a002776f2d1"
        }
    },
    "access_token": "5c3527294ed6b8002bfa1f3f",
    "account_class": "DEBIT_CARD",
    "card_hash": "e21dfdd86e735b91d24ab0d3977f632bcbd90b93d4608fa7c80f512460e998e9",
    "card_number": "1765",
    "card_style_id": null,
    "client": {
        "id": "5ade26b4567a900029e2afd2",
        "name": "YY Test Company"
    },
    "cvc": "***",
    "exp": "2023-02-06",
    "nickname": "My Debit Card",
    "node_id": "5c35271a51112300616fbaf6",
    "preferences": {
        "allow_foreign_transactions": false,
        "daily_atm_withdrawal_limit": 100,
        "daily_transaction_limit": 1000,
        "spending_limit": false
    },
    "status": "TERMINATED",
    "user_id": "5c35270170c557005d9365f7"
}

Subscribe to Webhooks

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

Delete Card


Use this API call to terminate 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.