Desabilitar uma conta

Este endpoint permite realizar o bloqueio temporário de acesso do usuário a uma conta

Pré-requisitos

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

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

Requisição (Request)

Requisição HTTP

PATCH https://sandbox.hiperbanco.com.br/Accounts/block-user

--request PATCH 'https://sandbox.hiperbanco.com.br/Accounts/block-user' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
    "onboardingId": "5214cfed-5712-45b6-a2fb-4677290a5a92",
    "block": true,
    "reason": "COMMERCIAL_DISAGREEMENT"
}'

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 Autenticação Gestão do Banco.

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.
`block`	`boolean`	Propriedade que indica que deve bloquear (O valor deve ser sempre true).
`reason`	`string`	Motivo do bloqueio.

{
    "onboardingId": "5214cfed-5712-45b6-a2fb-4677290a5a92",
    "block": true,
    "reason": "COMMERCIAL_DISAGREEMENT"
}

Motivos de bloqueio

Nome	Descrição
`COMMERCIAL_DISAGREEMENT`	Solicitação do cliente: O usuário solicita ao parceiro o bloqueio temporário de sua conta.
`HOLDER_REQUEST`	Solicitação do cliente: O parceiro Hiperbanco realiza o bloqueio temporário de sua conta.

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
`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.
`409`	`ONBOARDING_ALREADY_BLOCKED`	The onboarding is already blocked.	O onboarding já está bloqueado.
`409`	`ONBOARDING_ALREADY_UNBLOCKED`	The onboarding is already unblocked.	O onboarding já está desbloqueado.

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

Eventos

Este endpoint não possui eventos relacionados a ele.