Remove Contato da Conta

Permite remover um contato vinculado a uma conta por meio de um endpoint.

Endpoint: DELETE /accounts/{account}/contacts/{contactId}

Passos para Integrar

1. Realizar autenticação na API - [API Reference]
2. Realizar a remoção de um contato da conta - [API Reference]

Parâmetros da requisição

Regras gerais

• A remoção é realizada por meio dos parâmetros de rota account e contactId.
• O contato precisa estar com status ACTIVE para ser elegível à remoção.
• Contatos com status diferente de ACTIVE, incluindo REMOVED ou PENDING, são tratados como não encontrados e retornam o mesmo erro ao cliente.
• O comportamento da API depende da classificação do contato:
  • Contato comum: a remoção é realizada de forma síncrona e a API retorna 200 OK, com status SUCCESS.
  • Favorito: a remoção do contato da base ocorre imediatamente, enquanto a baixa correspondente no motor de limites é processada de forma assíncrona. Nesse caso, a API retorna 200 OK, com status PROCESSING.
  • Nos dois casos, o contato é removido da base e passa para o status REMOVED durante a chamada.
  • Após a finalização será enviado um Webhook com o evento favorite e o Status REMOVED.

cURL da chamada.

curl --request DELETE \
  --url 'https://sandbox.openfinance.celcoin.dev/baas/v2/accounts/30000/contacts/6f1b2c3d-4e5f-4a6b-8c9d-abc123456789' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Accept: application/json'

Exemplos de retorno

{
  "status": "SUCCESS",
  "version": "1.0.0"
}

{
  "status": "PROCESSING",
  "version": "1.0.0"
}

{
  "status": "ERROR",
  "version": "1.0.0",
  "error": {
    "errorCode": "CBE523",
    "message": "<limitType` não informado>"
  }
}

Webhook

Exemplo de webhook

{
  "entity": "favorite",
  "status": "REMOVED",
  "webhookId": "9b1f3c6e-4d2a-4f7b-a8e1-5c3d2b7f9a10",
  "createTimestamp": "2026-10-23T14:20:05.4127731Z",
  "body": {
    "contactId": "2a5bd7c2-47a4-435f-80b4-62098e4e49df",
    "alias": "Luana - Fornecedor",
    "status": "REMOVED",
    "favorite": false,
    "creditParty": {
      "bank": "13935893",
      "account": "300541234567890",
      "branch": "0001",
      "taxId": "12345678000199",
      "name": "Fornecedor Jornada",
      "accountType": "CACC",
      "key": null,
      "personType": "LEGAL_PERSON"
    },
    "createdAt": "2026-10-21T13:33:58.114Z",
    "updatedAt": "2026-10-23T14:20:05.4127731Z"
  }
}

Tabela de errorCode