Openi DeveloperDeveloper
Items

Deletar Item

Remove uma conexão bancária existente. O item deixa de aparecer nos demais endpoints e a conexão com a instituição financeira é encerrada.

Endpoint

Método e URL:

DELETE /v1/items/:id

Parâmetros da URL:

  • id (string, obrigatório): Identificador único do item (UUID v7)

Exemplo de Uso

Requisição:

DELETE /v1/items/01985c42-1234-5678-9abc-def123456789

Resposta

Resposta de sucesso (200):

{
  "status": "success",
  "data": {}
}

Resposta de erro (404):

{
  "status": "error",
  "message": "Item not found."
}

Comportamento

Quando você chama este endpoint:

  1. Validação: O sistema verifica se o item existe e pertence à sua conta
  2. Encerramento no provedor: A conexão com a instituição financeira é removida
  3. Remoção: O item é marcado como deletado e deixa de aparecer nos demais endpoints
  4. Webhook: O evento ITEM_DELETED é disparado

Notas

  • A exclusão é irreversível: para reconectar a instituição, crie um novo item com Criar Item
  • Após a exclusão, chamadas aos endpoints do item (buscar, ressincronizar, contas, transações) retornam 404
  • Deletar um item que já foi deletado também retorna 404
  • Use o webhook ITEM_DELETED para reagir à exclusão em seus sistemas

On this page