Reanálise do limite de contrato de crédito

stable

Este endpoint permite solicitar a reanálise do limite de um contrato de crédito de seu cliente.

Havendo alteração no contrato, o cliente deverá dar o aceite dos novos termos.

🚧

Importante

Seguindo as normativas do Banco Central, caso o limite de um cliente seja reduzido após a reanálise, o contrato será alterado automaticamente em 5 dias. Dessa forma, não é necessário um novo aceite da alteração.

Pré-requisito

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

  • Possuir uma proposta de crédito aprovada e um contrato de crédito emitido.

Requisição

Requisição HTTP

PUT 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contract/{contract}/reanalyze'
--request PUT \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/47742663023/contract/{contract}/reanalyze' \
--header 'Authorization: Bearer' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--data '
{
     "origin": "CUSTOMER_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:

ScopeDescrição
credit.writeConcede acesso para solicitar análise ou reanálise de crédito para um cliente.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

NomeTipoDescriçãoEspecificação
documentNumberpathObrigatório. Número do documento do cliente (CPF ou CNPJ).Informe somente números.
contractpathObrigatório. Número do contrato de crédito do cliente.

Corpo da requisição (Body)

No body, envie o seguinte campo em formato JSON:

NomeTipoDescriçãoEspecificação
originstringObrigatório. Solicitante do chamado de reanálise, que pode ser “CUSTOMER_REQUEST” (cliente pessoa física) ou “COMPANY_REQUEST” (cliente pessoa jurídica) .
{
     "origin": "CUSTOMER_REQUEST"
}

Resposta (Response)

O status code 202 indicará que a solicitação de reanálise do limite de um contrato de crédito foi criada com sucesso.

👍

Dica

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

Erros

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

Status CodeCódigoMensagemDescrição
406OPERATION_NOT_ALLOWED_AMENDMENT_STATUSOperation not allowed for amendment status!Esse contrato já está em reanálise.
406OPERATION_NOT_ALLOWED_AMENDMENT_REANALYZE_DATEOperation not allowed for amendment reanalyze date, must be more than ${intervalOfDays} days!Não é possível criar a solicitação, pois esse contrato já passou por uma reanálise de crédito recentemente. Uma nova requisição poderá ser feita 30 dias após a data da solicitação da última reanálise. Exemplo: se a reanálise do contrato foi realizada em 30/12/2022, uma nova reanálise poderá ser solicitada em 30/01/2023.

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 eventoDescrição
CREDIT_CARD_LIMIT_INCREASE_REQUESTEDApós reanálise, o aumento do limite de crédito do cliente foi aprovado.
CREDIT_CARD_LIMIT_INCREASE_REFUSEDApós reanálise, o aumento de limite de crédito do cliente foi recusado.
CREDIT_CARD_LIMIT_REDUCTION_REQUESTEDApós reanálise, a diminuição do limite é solicitada, para ocorrer 30 dias após a decisão, seguindo o art. 10, §1º, I, da Resolução n.º 96/2021 do Bacen.