Issue new card

Issue a new virtual or physical card. User must complete KYC first.

POST /api/v1/cards

Issue new card

cURL

curl --request POST \
  --url https://api.hevn.finance/api/v1/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "format": "virtual"
}
'

import requests

url = "https://api.hevn.finance/api/v1/cards"

payload = { "format": "virtual" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({format: 'virtual'})
};

fetch('https://api.hevn.finance/api/v1/cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "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>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<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

Body

application/json

Request to issue a new card.

format · enum<string> · default: virtual

Card format.

Available options: virtual, physical

Response

201

application/json

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 | 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