Pessoa jurídica
stable scopes: business.cancel business.read
O Offboarding de pessoa jurídica, ou encerramento de vínculo comercial, consiste no cancelamento dos seguintes produtos:
- Registro do cliente;
- Contas;
- Cartões vinculados à conta.
Importante
É preciso realizar a exclusão de todas as chaves Pix atreladas ao documento antes de solicitar o seu Offboarding.
Offboarding de origem externa
Esse tipo de encerramento de vínculo comercial pode ocorrer devido a:
- Solicitação do cliente (HOLDER_REQUEST): o representante legal da empresa solicita ao parceiro Bankly o encerramento do vínculo;
- Desacordo comercial (COMMERCIAL_DISAGREEMENT): o parceiro Bankly opta pelo encerramento do vínculo. Nesse caso, o parceiro deve notificar à empresa a respeito do encerramento.
Pré-requisitos
Para efetivar o processo de encerramento, a conta:
- Deve ter status ativo (ACTIVE);
- Não deve possuir saldo disponível e nem bloqueado.
Importante
É preciso realizar a exclusão de todas as chaves Pix atreladas ao documento antes de solicitar o seu Offboarding.
Etapas
Requisição de Offboarding
Para solicitação do Offboarding, basta efetuar uma requisição no endpoint de encerramento de vínculo comercial, e todos os produtos vinculados à conta em questão serão cancelados.
Endpoint
Para consumo deste endpoint, preencha os seguintes parâmetros obrigatórios:
documentNumber
: informe o CNPJ da conta;reason
: informe o motivo do encerramento (HOLDER_REQUEST ou COMMERCIAL_DISAGREEMENT).
--request PATCH
--url'https://api-mtls.sandbox.bankly.com.br/business/{{document_number}}/cancel' \
--header 'api-version: 1' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--data-raw '
{
"reason": "HOLDER_REQUEST"
}
Retorno
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.
Erros
Status code | Código | Descrição |
---|---|---|
400 | HOLDER_HAS_SOME_ACCOUNTS_WITH_NON_ZERO_BALANCE | Há uma ou mais contas que apresentam saldo. |
404 | --- | O CNPJ não tem cadastro aprovado. |
422 | HOLDER_HAS_ALREADY_BEEN_CANCELED | O vínculo já foi encerrado. |
Caso o retorno indique saldo na conta, basta zerá-la e chamar o endpoint novamente.
Verificação do status
Para conferir o status do encerramento do vínculo, utilize o endpoint de consulta de registro do cliente. Basta informar o documentNumber
do cliente no path da requisição.
Importante
Indicamos que você verifique o
Cache-Control
no header da requisição, pois ele indicará o tempo a ser aguardado para fazer uma nova consulta.
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/business/{{documentNumber}}'
--header 'Accept: application/json'
--header 'api-version: 1'
--header 'Authorization: Bearer {{accessToken}}'
O status do cliente pós-encerramento deve ser CANCELLED.
Caso algum dos status retorne insucesso, entre em contato com Service Desk.
O encerramento técnico acontece após as etapas mencionadas. No entanto, o encerramento jurídico, ocorrerá após 30 dias a partir da requisição.
Para mais informações, consulte a Visão geral desta documentação.
Importante
A partir do pedido de encerramento, o seu cliente não conseguirá receber ou enviar dinheiro por meio de sua conta. Porém, caso ele receba reembolso da bandeira, poderá realizar transações com o cartão durante o período de 30 dias.
Evidência de pedido de cancelamento
Ao realizar o Offboarding por solicitação do seu cliente (HOLDER_REQUEST), obrigatoriamente você deverá armazenar a evidência de que o vínculo foi encerrado a pedido do cliente. Essa evidência poderá ser solicitada a qualquer momento por razões de auditoria.
Para mais informações, consulte a Resolução Nº 96, de 19 de maio de 2021.
Offboarding de origem interna
O Bankly realiza análises contínuas e, se confirmada alguma irregularidade, como fraude, por exemplo, realizará o que chamamos de Offboarding de origem interna. Ou seja, o Bankly tomará as medidas necessárias para o encerramento do vínculo comercial.
Portanto, nesses casos, o parceiro não realizará nenhum procedimento, e o cliente passará a ter o status BLOCKLISTED.
Para consultar seu status, utilize o mesmo endpoint descrito anteriormente para Offboarding de origem externa.
Updated 12 months ago