Consultar o status de um token de cartão salvo
Verifique se um token de cartão salvo ainda pode ser cobrado e quando os dados do cartão serão apagados.
GET /token/{token} informa se um token que você armazenou ainda pode ser cobrado. Chame-o antes de uma nova tentativa ou de uma cobrança agendada quando você guarda tokens por muito tempo, ou depois de receber um webhook token.deleted ou token.erased.
Um token está em um de quatro estados:
erasesAt fica vazio enquanto uma assinatura ativa ou um beneficiário de repasses ainda usa o cartão (heldBySubscription é true). Ele se move para mais adiante sempre que o token é usado de novo. Depois do apagamento, brand, last4, expiryMonth e expiryYear permanecem, então pagamentos antigos continuam mostrando o cartão.
Veja o ciclo de vida do token para as regras de retenção e os códigos de erro que uma cobrança retorna.
Autorizações
Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).
Parâmetros de caminho
The token returned when the card was stored (vt_...).
Parâmetros de consulta
Your merchant account identifier.
Resposta
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.