Pessoa jurídica

stable

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

Pré-requisito

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.

Requisição

Requisição HTTP

HTTP

PATCH https://api-mtls.sandbox.bankly.com.br/business/{{document_number}}/cancel

cURL

--request PATCH \
--url'https://api-mtls.sandbox.bankly.com.br/business/{{document_number}}/cancel' \ 
--header 'api-version: 1.0' \ 
--header 'Authorization: Bearer {{Token}}' \ 
--header 'Content-Type: application/json' \ 
--data-raw ' 
			{ 
			    "reason": "HOLDER_REQUEST" 
			}

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
business.cancel	Concede acesso para encerrar o vínculo comercial com um cliente pessoa jurídica de qualquer tipo.

Cabeçalhos (Headers)

Nome	Descrição
api-version	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
Authorization	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

Nome	Tipo	Descrição
documentNumber	path	Obrigatório. Número do CNPJ do cliente.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

Nome	Tipo	Descrição
reason	string	Motivo do encerramento, o qual pode ser HOLDER_REQUEST (solicitação do cliente) ou COMMERCIAL_DISAGREEMENT (desacordo comercial).

JSON

{ 
    "reason": "HOLDER_REQUEST" 
}

Resposta (Response)

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

Caso o cliente possua apenas seus dados cadastrados, sem uma conta aberta no Bankly, o retorno de sucesso do Offboarding será o status code 204.

🚧

Importante

O status do cliente pós-encerramento deve ser CANCELED. Caso algum dos status retorne insucesso, entre em contato com Service Desk.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Verificação do status

Para conferir o status do encerramento do vínculo, utilize o endpoint de consulta de registro do cliente.

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.

📘

Nota

Caso o retorno indique saldo na conta, basta zerá-la e chamar o endpoint novamente.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês 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.
BUSINESS_WAS_CANCELED	O cadastro do cliente foi cancelado.