Archive a card template (soft delete)

Archive a card template (soft delete). Existing customers enrolled in the card keep their wallet passes and continue to earn/redeem; the card is removed from the public catalog and POST /v1/customers with this card_id returns 404. To permanently delete with GDPR right-to-be-forgotten (PII anonymization for enrolled customers), include ?gdpr=true. Returns 409 (code card_has_active_customers) if you pass gdpr=true against a card that is still ACTIVE and has enrolled customers: the irreversible PII cascade is gated behind archive-first. Archive the card (a plain DELETE, which is safe - enrolled customers keep their passes and keep earning), migrate customers as needed, then retry with gdpr=true against the archived card. Side effect: fires card.deleted webhook event with deletion_type (‘archived’ or ‘gdpr_redacted’). Archiving is idempotent: calling DELETE again on an already-archived card returns 200 with the same envelope (deletion_type and archived_at unchanged, and enrolled_customers_count not re-counted), never 404.

DELETE /v1/cards/{id}

Archive a card template (soft delete)

cURL

curl --request DELETE \
  --url https://api.vexioncards.one/v1/cards/{id} \
  --header 'Authorization: Bearer <token>'

200

Archived

{
  "id": "crd_sophcrprtvpmmnwxah2lomnkee",
  "object": "card",
  "deleted": true,
  "deletion_type": "archived",
  "archived_at": 1782604800,
  "card_id": "crd_sophcrprtvpmmnwxah2lomnkee",
  "status": "archived",
  "enrolled_customers_count": 42
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Headers

Idempotency-Key · string

Recommended on PATCH and DELETE for safe retries.

Maximum string length: 255

Accept-Language · enum<string> · default: sk

Preferred language for error messages and localized fields. One of sk, cs, en, de. Defaults to card's default_language.

Available options: sk, cs, en, de

Path Parameters

id · string · required

Card template identifier. Opaque, server-issued token, e.g. crd_c4zdlocdwajf6wtmnvvkonv4oa.

Pattern: ^crd_[A-Za-z0-9]+$

Query Parameters

gdpr · boolean · default: false

If true, permanently anonymizes all enrolled customer PII for this card (GDPR right-to-be-forgotten). Default false (soft archive).

Response

200

application/json

Card deleted.

id · string · required

The archived card id. Duplicated as card_id for symmetry with other deletion-confirmation envelopes.

object · enum<string> · required

Available options: card

deleted · boolean · required

deletion_type · enum<string> · required

archived for a plain soft archive, gdpr_redacted when ?gdpr=true also anonymized every enrolled customer.

Available options: archived, gdpr_redacted

archived_at · integer | null · required

Unix seconds when the card was first archived. Preserved (not restamped) on a repeat archive.

card_id · string · required

status · enum<string> · required

Available options: archived

enrolled_customers_count · integer

Holders enrolled at the moment of archive. Returned only when gdpr is false or omitted.

gdpr_redacted_customers_count · integer

Customers irreversibly anonymized by this call. Returned only when gdpr=true.