Skip to main content
PUT
/
api
/
v1
/
cards
/
{card_id}
/
label
Set card label
curl --request PUT \
  --url https://api.hevn.finance/api/v1/cards/{card_id}/label \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>"
}
'
{
  "id": "<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>",
    "cardName": "<string>"
  },
  "createdAt": "<string>",
  "activated": false,
  "billingAddress": {
    "streetAddress": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "dailySpend": 0,
  "label": "<string>"
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
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
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

Successful Response

Card response - universal format for any provider.

​
id
string
required
​
walletAddress
string | null

Linked wallet address

​
status
enum<string>
default:pending

Card status.

Available options:
pending,
active,
blocked,
closed
​
limit
CardLimit · object

Card spending limit.

​
cardData
CardData · object

Card display data (non-sensitive).

​
createdAt
string | null
​
activated
boolean
default:false

True if card details have been revealed and cached

​
billingAddress
UserAddress · object

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.

​
dailySpend
number
default:0

Total spent today on this card (from fiat_transfers)

​
label
string | null

User-defined card label/nickname