Cards

Archive the card — settles with the issuer asynchronously

Kept for existing integrations; POST /v1/cards/{card_id}/archival is the same archive. The card drops out of the default /v1/cards list (filter[archived] brings it back), is read-only (freeze and cancel answer 409 until it is unarchived), and is closed at the provider in the background: frozen at Unit, deleted at Amex, deactivated at Astrada. A card already closed or frozen at the provider is left as it is. Unarchiving never reopens it. With card archiving not yet turned on for the account, it deletes the card instead (the same provider close, but the card can't be brought back), as it always has; that needs the role's Delete permission for the card type.

post/v1/cards/{card_id}/archive

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/cards/{card_id}/archive
  • Auth: HTTP bearer

Path parameters

card_idstring required

Response

Accepted; settles asynchronously.

Changes

No recorded changes to this operation across all 1 revision of this API.