Excluir um cartão

Visão Geral

Este endpoint permite remover de forma segura informações de cartão armazenadas na plataforma, garantindo a privacidade dos dados do cliente e facilitando a gestão de métodos de pagamento obsoletos ou não utilizados.

Precauções

ATENÇÃO! Por favor, leia estas informações importantes antes de usar este endpoint.

• Operação Irreversível: A exclusão de um cartão é uma operação irreversível. Todos os dados associados ao cartão serão permanentemente removidos.
• ID do Cartão: Certifique-se de utilizar um ID de cartão válido e existente no sistema.
• Cartão Principal: Tenha cuidado ao excluir um cartão principal. Certifique-se de que o cliente tenha outro cartão definido como principal antes de excluir o atual.

Descrição

O endpoint Excluir Cartão permite remover permanentemente um cartão do sistema.

Requisição

DELETE /v1/cards/{cardId}

Parâmetros da Requisição

Resposta - 200 OK

Se a requisição for bem-sucedida, um objeto JSON com a confirmação da exclusão é retornado.

Exemplo de Resposta

{
  "id": "card_01hqzvabc",
  "resource": "card",
  "deleted": true,
  "merchant": {
    "name": "Seller Name",
    "merchantId": "bus_1234567890",
    "isSubAccount": false
  },
  "_links": {
    "self": {
      "href": "https://api.selectwin.io/v1/cards/card_01hqzvabc",
      "method": "GET",
      "description": "Read a card."
    },
    "create": {
      "href": "https://api.selectwin.io/v1/cards",
      "method": "POST",
      "description": "Create a new card."
    },
    "delete": {
      "href": "https://api.selectwin.io/v1/cards/card_01hqzvabc",
      "method": "DELETE",
      "description": "Delete the card."
    },
    "list": {
      "href": "https://api.selectwin.io/v1/cards",
      "method": "GET",
      "description": "List all cards."
    }
  }
}

Atributos da Resposta

Respostas de Erro

404 Not Found - Cartão Não Encontrado

{
  "error": {
    "status": "Not Found",
    "statusCode": 404,
    "category": "client",
    "code": "cardIdNotFound",
    "message": "Card ID not found.",
    "resource": "card",
    "details": "The card ID was not found. Please check the card ID and try again."
  }
}

Códigos de erro deste endpoint

Casos de Uso

1. Gestão de Métodos de Pagamento: Permitir que o cliente remova cartões indesejados ou expirados
2. Privacidade de Dados: Remover informações de cartão quando solicitado pelo cliente
3. Manutenção de Conta: Limpar cartões obsoletos após a adição de novos métodos de pagamento
4. Segurança: Excluir cartões comprometidos após detecção de fraude

Melhores Práticas

1. Confirmação do Usuário: Solicite confirmação explícita do usuário antes de excluir um cartão
2. Verificação de Cartão Principal: Verifique se o cartão a ser excluído é o principal e, se for, solicite que outro seja definido antes
3. Feedback Claro: Forneça feedback imediato e claro sobre o resultado da operação
4. Tratamento de Erros: Implemente tratamento adequado para todos os códigos de erro possíveis
5. Auditoria: Mantenha um registro das exclusões de cartão para fins de auditoria

Integração com Outros Endpoints

• Use Consultar Cartão antes da exclusão para verificar os detalhes do cartão
• Use Listar Cartões para encontrar todos os cartões de um cliente
• Use Criar Cartão para adicionar um novo cartão para substituir o excluído