Cancelamento de conta do onboarding

Este endpoint possibilita o cancelamento de uma conta bancária específica de um onboarding.

⚠️
Importante
O processo de cancelamento é assíncrono e será processado em background.

📘
Nota
Quando todas as contas vinculadas a um onboarding forem canceladas, o registro de onboarding correspondente será automaticamente encerrado.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessario que:

O usuário esteja utilizando a Autenticação Gestão do Banco.

Requisição (Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/Accounts/{{onboardingId}}/{{accountId}}

--request DELETE 'https://sandbox.hiperbanco.com.br/Accounts/{{onboardingId}}/{{accountId}}' \
--header 'version: cutting-edge' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: multipart/form-data' \
--form 'reason="{{motivo}}"' \
--form 'proof=@"/path/to/file"'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Content-Type`	`multipart/form-data`	Obrigatório, pois o body é enviado em formato de formulário.
`Authorization`	`Bearer {{accessToken}}`	Obrigatório. Este endpoint requer autenticação.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição	Especificação
`onboardingId`	`path`	Obrigatório. ID do onboarding.	UUID
`accountId`	`path`	Obrigatório. ID da conta.	UUID

Corpo da requisição (Body)

No body, envie os seguintes campos em formato de formulário (formData):

Nome	Tipo	Descrição
`reason`	`text`	Obrigatório. Motivo pelo qual a conta será cancelada. Pode ser "HOLDER_REQUEST" (solicitação do cliente) ou "COMMERCIAL_DISAGREEMENT" (desacordo comercial).
`proof`	`file` (binary)	Arquivo de comprovante. Opcional. Formatos aceitos: `.jpg`, `.jpeg`, `.png`, `.pdf`, Tamanho máximo de `10MB`.

--form 'reason="Solicitação do cliente"' \
--form 'proof=@"/path/to/file"'

Resposta (Response)

O status code 200 indicará sucesso na operação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`message`	`string`	Mensagem de confirmação do envio da solicitação de cancelamento.

{
    "message": "Deletion request sent successfully."
}

Erros

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

Status Code	Código	Mensagem	Descrição
`400`	`FILE_REQUIRED`	Proof is required	Ocorre quando o campo `proof` é obrigatório para a solicitação, mas não foi enviado.
`400`	`INVALID_REQUEST`	Invalid request	Ocorre quando um arquivo não permitido é enviado ou a requisição não atende às validações.
`401`	`UNAUTHORIZED_ACCESS`	Authentication has failed or has not been provided.	Ocorre quando a requisição não possui autenticação válida.
`404`	`ONBOARDING_NOT_FOUND`	Resource not found.	Ocorre quando o onboarding ou a conta informados não são encontrados.
`409`	`ACCOUNT_ALREADY_IN_CANCELLATION_PENDING`	Account in invalid state.	Ocorre quando a conta já está em processo de cancelamento, já foi cancelada ou está inativa.

Eventos

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

Para clientes pessoa física:

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 (PF) foi cancelado.
`BUSINESS_WAS_CANCELED`	O cadastro do cliente (PJ) foi cancelado.