Freeze Card

put/cards/{cardId}/status

Path parameters

cardIdstring uuid required

The unique identifier for the card whose status you want to change or from FROZEN to ACTIVE or from ACTIVE to FROZEN

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Request body

freezeboolean required

A boolean parameter that sets the card’s freeze status. Possible values:

true: Sets the card status to FROZEN

false: Reverts the freeze if the card is currently FROZEN. Note that this does not necessarily make the card ACTIVE; it may return to another status that could still restrict usage.

Response

Return status after the update

freezeboolean required

A boolean indicating the card’s current freeze status. Possible values:

true: The card is currently FROZEN.

false: The freeze has been lifted if the card was previously FROZEN. Note that this does not necessarily mean the card is ACTIVE; it may have reverted to another status that could still restrict usage.

Changes

No recorded changes to this endpoint across all 1 revision of this API.