Encerramento de contas

Este endpoint permite realizar o encerramento de vínculo comercial com cliente do tipo pessoa física e jurídica (cancelamento de registro, contas, cartões e chaves Pix).

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que a conta:

Possua status ativo (ACTIVE);
Não apresente saldo disponível e nem bloqueado.

⚠️
Importante
Em caso de desacordo comercial (COMMERCIAL_DISAGREEMENT), será possível realizar o Offboarding de clientes cujas contas possuam saldo disponível ou bloqueado realizando abertura de chamado pelo Service Desk

Requisição (Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/Accounts/user

--request DELETE 'https://sandbox.hiperbanco.com.br/Accounts/user' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
    "onboardingId": "ff19d91b-3b8a-4a1e-946a-b65ea4afb242",
    "reason": "HOLDER_REQUEST"
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	Obrigatório. Token de autorização do tipo Bearer.

📘
Nota
O Bearer token utilizado nessa requisição é obtido por meio da rota de login do backoffice: POST /Backoffice/Login.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`onboardingId`	string	ID do onboarding do usuario Esse ID pode ser Obtido por meio da rota GET /dashboard/accounts
`reason`	string	Motivo do encerramento, que pode ser "HOLDER_REQUEST" (solicitação do cliente) ou "COMMERCIAL_DISAGREEMENT" (desacordo comercial).

{
    "onboardingId": "0a50a787-5ec5-4120-a34e-3485f7d98c8b",
    "reason": "HOLDER_REQUEST"
}

Resposta (Response)

O status code 200 indicará que o Offboarding foi realizado com sucesso.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Código	Mensagem	Descrição
422	HOLDER_HAS_SOME_ACCOUNTS_WITH_NON_ZERO_BALANCE	Holder has some accounts with a balance greater than zero. These accounts must be settled before requesting the end of business relationship with the account holder.	Há uma ou mais contas que apresentam saldo.
422	HOLDER_HAS_ALREADY_BEEN_CANCELED	Holder has already been canceled.	O vínculo já foi encerrado.
404	ONBOARDING_NOT_FOUND	Onboarding not found with ID 0a50a787-5ec5-4120-a34e-3485f7d98c8b.	Onboarding não encontrado com ID ab332502-7136-455d-94ee-994eb34ff431.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Caso o parceiro deseje receber mensagens referentes aos eventos relacionados a esse endpoint, é preciso configurar o webhook. Os eventos são:

Nome do evento	Descrição
ACCOUNT_HOLDER_WAS_CANCELED	O vínculo com o titular da conta foi encerrado.
CUSTOMER_WAS_CANCELED	O cadastro do cliente foi cancelado.
BUSINESS_WAS_CANCELED	O cadastro do cliente foi cancelado.