Buvei
API ReferenceCards

Freeze Card

Temporarily suspend a card so it cannot authorise new transactions.

POST/open-api/v1/cards/{cardId}/freeze

Frozen cards reject all new authorisations until unfrozen. The card's balance is preserved.

Path parameters

cardIdstringpathrequired

Body

No body.

Response

successboolean
cardIdstring
statusstring
"FROZEN" on success — the resource's status as returned by GET /cards/{cardId} will be "DISABLE".
messagestring
frozenAtinteger
Epoch milliseconds.
Response
{
  "code": 0,
  "message": "SUCCESS",
  "data": {
    "success": true,
    "cardId": "cid_abc123def456",
    "status": "FROZEN",
    "message": "Card frozen successfully",
    "frozenAt": 1640995200000
  }
}

Pending authorisations on a card at the moment it is frozen will be declined. The funds remain on the card and are accessible after unfreezing.

On this page

Path parameters
Body
Response