Excluir uma carteira

Visão Geral

Este endpoint arquiva (remove) uma carteira do sistema. A operação é irreversível: os dados bancários sensíveis são apagados (scrub de PII) e a carteira é marcada como arquivada.

Precauções

• A exclusão de uma carteira é irreversível — os dados bancários são removidos no processo.
• Não é possível excluir uma carteira que possui um saque em andamento para ela (409 walletHasPendingWithdrawal). Aguarde a conclusão do saque.
• Saques em andamento mantêm seu próprio snapshot dos dados bancários (receivingBankAccount), capturado no momento da solicitação, portanto continuam consultáveis mesmo após a carteira ser arquivada.
• Apenas carteiras da empresa autenticada podem ser excluídas.

Descrição

A exclusão de carteira é útil quando você deseja remover uma conta bancária que não será mais utilizada para recebimentos. Isso ajuda a manter sua lista de carteiras organizada e atualizada.

Requisição

DELETE /v1/wallets/{walletId}

Parâmetros de Caminho

Exemplo de Requisição

DELETE /v1/wallets/wall_01hqzvabc

Resposta

Sucesso (200 OK)

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

Atributos da Resposta

Erros Comuns

Melhores Práticas

1. Verifique se não há saque em andamento para a carteira antes de tentar excluí-la (caso contrário recebe 409).
2. Confirme a exclusão com o usuário antes de fazer a requisição, pois a operação é irreversível.
3. Implemente tratamento de erros para lidar com casos onde a carteira não pode ser excluída.
4. Mantenha outra carteira principal caso exclua a atual primary, usando PATCH /v1/wallets/{walletId}/set-primary.