Skip to content

Freeze Card

Endpoint

PUT/api/v1/merchant/cards/{cardId}/freeze/

This endpoint allows for the freezing of the card in the event of card loss or suspected fraudulent use.

Path Parameters

Name Type Required Description
cardId string ✅ The unique identifier for the card to be frozen.

Request Body

{
  "freeze": true
}

Body Parameters

Name Type Required Description
freeze boolean ✅ A boolean parameter to freeze the card. Set to true to freeze the card. Set to false to unfreeze the card.

Example Request

PUT /api/v1/merchant/cards/5398472c-f898-48da-b5a6-e066dd85bd13/freeze/
Content-Type: application/json
x-payments-api-key: 22bfefe264f4ce9fb5d07d09ad92cea60a0ff489

{
  "freeze": true
}

Response

{
  "freeze": "true"
}

Response Codes

Status Code Description
200 OK Card successfully frozen.
400 Bad Request Invalid request parameters.
401 Unauthorized Authentication failed.
404 Not Found Card not found.

Response Status Examples

200 OK 
{
  "freeze": true
}
400 Bad Request 
{
  "code": 59,
  "message": "Card is blocked due to suspected fraud",
  "status": "failed"
}
404 Not Found 
{
  "code": 404,
  "message": "Record not found",
  "status": "failed"
}