Skip to main content
DELETE
Esta rota exclui um cartão salvo. O token é revogado no cofre da Finvia e não pode mais ser usado em cobranças nem em assinaturas. Depois da exclusão, o cartão aparece com status revoked em Listar cartões quando a listagem é feita sem o filtro customerId; com o filtro, ele deixa de aparecer. Use quando o cliente remove o cartão da conta dele no seu site ou quando o cartão deixa de ser válido para o seu negócio.

Quando usar

Antes de chamar

  • Tenha uma chave secreta (sk_) da conta que registrou o cartão (Credenciais e ambientes).
  • Tenha o id do cartão.
  • Verifique se o cartão está em uso em alguma assinatura ativa.
A exclusão revoga o token: o cartão deixa de poder ser usado em cobranças e em assinaturas. Se ele estiver vinculado a uma assinatura ativa, as próximas renovações não poderão usá-lo. Para trocar o cartão de uma assinatura, crie a nova assinatura com o novo cartão antes de excluir o antigo.

Parâmetros de caminho

string
required
Identificador único do cartão. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
Esta rota não tem corpo de requisição.

Respostas

string
ID do cartão excluído. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.
boolean
Confirmação da exclusão. Ex.: true.
string
Mensagem de retorno. Ex.: Card deleted successfully.
Para o negócio: oferecer ao cliente a opção de remover o cartão salvo dá a ele controle sobre os próprios dados de pagamento. A remoção é definitiva para aquele token: se o cliente quiser usar o mesmo cartão de novo, ele precisa ser registrado outra vez.

Erros comuns

Veja também

Cofre de cartões

Ciclo de vida do cartão salvo.

Ciclo de vida da assinatura

Cancelar e recriar assinatura para trocar o cartão.

Cobrança com cartão salvo

Uso do cardTokenId em recompras.

Registrar cartão

Guardar um novo cartão.