Set card label

Set or clear a user-defined label (nickname) for a card by Card UUID. Local-only, not sent to provider.

PUT /api/v1/cards/{card_id}/label

Set card label

cURL

curl --request PUT \
  --url https://api.example.com/api/v1/cards/{card_id}/label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalId": "<string>",
  "walletAddress": "<string>",
  "status": "pending",
  "limit": {
    "dailyLimit": 123,
    "dailyUsage": 0,
    "monthlyLimit": 123,
    "monthlyUsage": 0,
    "lifetimeLimit": 123,
    "lifetimeUsage": 0,
    "currency": "EUR"
  },
  "cardData": {
    "nameOnCard": "<string>",
    "paymentSystem": "<string>",
    "lastFour": "<string>",
    "expiryDate": "<string>",
    "format": "virtual",
    "cardName": "<string>"
  },
  "createdAt": "<string>",
  "activated": false,
  "billingAddress": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "AF",
    "zip": "<string>"
  },
  "dailySpend": 0,
  "label": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Path Parameters

card_id · string<uuid> · required

Body

application/json

Request to set a user-defined card label.

label · string | null

Label/nickname (null to clear)

Maximum string length: 64

Response

200

application/json

Successful Response

Card response - universal format for any provider.

id · string<uuid> · required

externalId · string · required

Provider-specific card identifier.

walletAddress · string | null

Linked wallet address

status · enum<string> · default: pending

Card status.

Available options: pending, active, blocked, closed

limit · CardLimit · object | null

Card spending limit.

Show child attributes

cardData · CardData · object | null

Card display data (non-sensitive).

Show child attributes

createdAt · string | null

activated · boolean · default: false

True if card details have been revealed and cached

billingAddress · UserAddress · object | null

Address schema for user.

Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.

Show child attributes

dailySpend · number · default: 0

Total spent today on this card (from fiat_transfers)

label · string | null

User-defined card label/nickname