Skip to main content
POST
Freeze a card

Authorizations

Api-Key
string
header
required

Partner API key. Must carry the cards permission.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. 2026-09.1. See Versioning.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

customerId
string
required

An individual, a business or an employee (cus_).

Example:

"cus_1Xb7..."

cardId
string
required

The card (crd_).

Example:

"crd_4fT9..."

Response

The card.

cardId
string
Example:

"crd_4fT9..."

cardholderId
string
Example:

"cus_8Qw2..."

businessId
string | null

The employee's business; null for an individual's card.

type
string

virtual.

kind
enum<string>
Available options:
standard,
single_use
status
enum<string>
Available options:
active,
frozen,
canceled
closedReason
enum<string> | null

Set when canceled: canceled (by you), spent (a used single-use card), expired.

Available options:
canceled,
spent,
expired,
null
displayName
string
last4
string
expiryMonth
string
expiryYear
string
controls
object
usage
object

spent is what the card has spent in the current limit period.

singleUse
object | null

Only for single-use cards; null otherwise.

createdAt
string<date-time>
updatedAt
string<date-time>