Get a Saved-Card Token's Status
Check whether a saved-card token can still be charged, and when its card data will be erased.
GET /token/{token} tells you whether a token you stored can still be charged. Call it before a retry or a scheduled charge when you keep tokens on your side for a long time, or after you receive a token.deleted or token.erased webhook.
A token is in one of four states:
erasesAt is empty while an active subscription or payout still uses the card (heldBySubscription is true). It moves later whenever the token is used again. After erasure brand, last4, expiryMonth and expiryYear stay, so past payments keep showing the card.
See Token lifecycle for the retention rules and the error codes a charge returns.
Authorizations
Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).
Path Parameters
The token returned when the card was stored (vt_...).
Query Parameters
Your merchant account identifier.
Response
Token status
active, deleted (still charges until erasesAt), erased (card data permanently erased; cannot be charged) or expired.
active, deleted, erased, expired When the card was deleted or retired.
deleted when the shopper or a support agent removed the card or a newer save replaced it; expired or unused when Therius retired it; null while the token is active.
When the card data was erased.
When the card data will be erased if the token is not used again. null while a live subscription or payout still uses the card. Using the token again moves this date.
true when a deleted card is kept because an active subscription still renews on it.
Card brand. Kept after the card data is erased.
Last four digits. Kept after the card data is erased.