curl -X POST "{{base_url}}/card/freeze" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card frozen successfully.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "frozen",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": null,
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T09:20:00+00:00"
}
}
Cards
Freeze card
Block spending on a cardholder’s open card.
POST
/
card
/
freeze
curl -X POST "{{base_url}}/card/freeze" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card frozen successfully.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "frozen",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": null,
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T09:20:00+00:00"
}
}
Freezes the cardholder’s open card. Status becomes
frozen. Unfreeze with POST /card/unfreeze.
The response is a card object without card_number or security_code.
string
required
Cardholder id returned by create card user.
Errors
| Message | When |
|---|---|
The user id field is required. | user_id is missing |
Card user not found. | user_id is missing for this partner |
Card not found. | The cardholder has no open card |
Partner not found. | The API key does not match a partner |
An unexpected error occurred. Please try again. | The card could not be frozen |
curl -X POST "{{base_url}}/card/freeze" \
-H "x-api-key: YOUR_CONSUMER_KEY" \
-H "Content-Type: application/json" \
-d '{"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"}'
{
"code": 200,
"message": "Card frozen successfully.",
"data": {
"user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"title": "Ada Lovelace",
"color": "black",
"name": "ADA LOVELACE",
"brand": "visa",
"currency": "USD",
"balance": "25.00",
"status": "frozen",
"mask": "424242******4242",
"last4": "4242",
"expiration": "12/28",
"is_non_subscription": true,
"is_contactless_payment": false,
"is_physical": false,
"billing_address": null,
"last_used_on": null,
"created_at": "2026-11-07T08:00:00+00:00",
"updated_at": "2026-11-07T09:20:00+00:00"
}
}