Skip to main content
GET
Esta rota devolve os detalhes de um cartão salvo: número mascarado, bandeira, validade e status. O status desta rota pode mostrar duas coisas diferentes, conforme o cartão: o cadastro do cartão na adquirente ou a situação dele no cofre (detalhes abaixo).
Hoje esta consulta pode mostrar active para um cartão já excluído ou vencido. Para decidir se um cartão pode ser usado em POST /v1/charges, use Listar cartões com customerId: a cobrança recusa cartão revoked ou expired, e a listagem mostra essa situação corretamente.

Quando usar

Antes de chamar

Parâmetros de caminho

string
required
Identificador único do cartão. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.

Respostas

string
ID do token do cartão. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
string
Token do cartão. Ex.: tok_abc123xyz.
string | null
Número mascarado do cartão. Ex.: ****1111.
string
Bandeira do cartão. Ex.: visa.
string
Mês de validade. Ex.: 12.
string
Ano de validade. Ex.: 2028.
string
Situação do cartão: active, inactive, pending_validation, expired ou revoked. Quando o cartão tem cadastro na adquirente, o valor mostra esse cadastro (active, inactive ou pending_validation). Só quando não há esse cadastro a rota mostra a situação no cofre (active, expired ou revoked).
string
Data e hora de criação (formato date-time). Ex.: 2024-01-15T10:30:00.000Z.
Para o negócio: quando o cartão de um assinante vence ou é recusado na renovação, não existe troca de cartão na assinatura. O caminho é registrar o cartão novo, cancelar a assinatura e criar outra. Consultar o status ajuda o atendimento a explicar ao cliente o que aconteceu.

Erros comuns

Veja também

Cofre de cartões

Ciclo de vida do cartão salvo.

Cobrança com cartão salvo

Recompra com cardTokenId.

Ciclo de vida da assinatura

Falha de renovação e troca de cartão.

Listar cartões

Todos os cartões de um cliente.