Freeze Card

Temporarily freeze a card to block all transactions

Endpoint: PATCH https://api.uncash.io/api/v1/cards/{id}/freeze

Path Parameters

Parameter	Type	Required	Description
id	string	Yes	The card ID (UUID) to freeze

Response

Success Response

Field	Type	Description
success	boolean	Indicates if the card was frozen successfully
message	string	Success message
timestamp	string	ISO 8601 timestamp

Data Object

Field	Type	Description
card_id	string	Card ID (UUID) that was frozen
status	string	New card status ("frozen")

Request Example

cURL

curl -X PATCH https://api.uncash.io/api/v1/cards/card-id/freeze \
  -H "Authorization: Bearer uc_your_api_token_here"

JavaScript

const response = await fetch('https://api.uncash.io/api/v1/cards/card-id/freeze', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer uc_your_api_token_here'
  }
});

const data = await response.json();

Python

import requests

url = "https://api.uncash.io/api/v1/cards/card-id/freeze"
headers = {"Authorization": "Bearer uc_your_api_token_here"}

response = requests.patch(url, headers=headers)
data = response.json()

Response Example

{
  "success": true,
  "message": "Card frozen successfully",
  "data": {
    "card_id": "card-id",
    "status": "frozen"
  },
  "timestamp": "2025-11-22T11:30:00.000Z"
}

Behavior

• Transaction Blocking: All card transactions will be declined while frozen
• Balance Preserved: Card balance remains unchanged
• Reversible: Card can be unfrozen using the unfreeze endpoint
• Provider Update: Freeze status is applied at the provider level

Notes

Use Case: Freeze your card temporarily if you suspect unauthorized access or lose your physical card details.

Validation Rules

• Card must be in "active" status
• Card must have a valid provider_id (not 'temp')

Error Responses

Already Frozen

{
  "success": false,
  "message": "Card is already frozen",
  "timestamp": "2025-11-22T10:00:00.000Z"
}

Invalid Status

{
  "success": false,
  "message": "Only active cards can be frozen",
  "timestamp": "2025-11-22T10:00:00.000Z"
}

Card Not Ready

{
  "success": false,
  "message": "Card is not ready for freeze operation",
  "timestamp": "2025-11-22T10:00:00.000Z"
}