Envio de dados para conclusão de alteração de limite
Quando uma reanálise de crédito é finalizada, são disparados eventos relativos às jornadas específicas de coleta de evidências junto ao portador do cartão de crédito (cliente do parceiro). Tais eventos são:
- CREDIT_CONTRACT_LIMIT_INCREASE_ON_HOLD, em caso de aumento do valor de limite do contrato de crédito, para coletar o aceite do portador;
- CREDIT_CONTRACT_LIMIT_REDUCTION_ON_HOLD, em caso de redução do valor de limite do contrato de crédito, para coletar evidência da notificação entregue ao portador.
Assim que as evidências forem coletadas, elas devem ser enviadas ao Bankly por meio do endpoint descrito a seguir, destinado à recepção dos dados para que o fluxo de alteração de limite seja finalizado.
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessário que:
- O pedido de reanálise de crédito tenha sido aprovado.
Requisição (Request)
Requisição HTTP
POST https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contract/{contractId}/solicitation/{solicitationId}/limitCommunication \--request PATCH \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contract/{contractId}/solicitation/{solicitationId}/limitCommunication' \
--header 'Authorization: Bearer' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--data '
{
"communication": {
"datahash": "string",
"communicatedAt": "",
"type": "limitIncreaceAccepted | limitIncreaseReproved| limitReductionNotNotified| limitReductionNotified"
}
}
'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 |
|---|---|
credit.write | Concede acesso para solicitar análise ou reanálise de crédito para um cliente e para enviar o aceite da proposta de crédito. |
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 os seguintes campos:
| Nome | Tipo | Descrição | Especificação |
|---|---|---|---|
documentNumber | path | Obrigatório. Número do documento do cliente (CPF ou CNPJ). | Informe somente números. Mínimo de 11 caracteres. |
contract | path | Obrigatório. Número do contrato de crédito do cliente. | Informe somente números. |
solicitationId | path | Obrigatório. Número de identificação da solicitação. | UUID V4 |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
communication | object | Obrigatório. Objeto que contém informações da comunicação com o cliente. |
communication.datahash | string | Obrigatório. Identificador que evidencia a coleta da comunicação. |
communication.communicatedAt | string | Obrigatório. Data em que a comunicação foi realizada com o cliente, no formato ISO 8601 - UTC. |
communication.type | string | Obrigatório. Tipos de Aceite de aumento podem ser limitIncreaceAccepted (para aceite de aumento de limite) e limitIncreaseReproved (para recusa de aumento de limite). Tipos de Noficação de redução podem ser limitReductionNotified (para notificação de redução de limite entregue com sucesso) ou limitReductionNotNotified (para notificação de redução de limite não conseguiu ser entregue). |
{
"communication": {
"datahash": "string",
"communicatedAt": "2025-04-29T21:41:51.978Z",
"type": "limitIncreaceAccepted"
}
}Resposta (Response)
O status code 202 indicará que o aceite da nova proposta do contrato de crédito foi enviado com sucesso.
DicaPara simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Assim que os dados forem recebidos na Bankly os eventos abaixo serão emitidos e caso o parceiro deseje receber mensagens é preciso configurar o webhook.
Os eventos são:
| Nome do evento | Descrição |
|---|---|
| CREDIT_CONTRACT_LIMIT_CHANGE_PARTNER_RESPONSE | Evento que indica o início do processo que confirma o recebimento da resposta por parte do parceiro de uma solicitação de alteração de limite. |
| CREDIT_CONTRACT_LIMIT_CHANGE_EXPIRED | Evento final que indica que a solicitação já estava expirada no momento do processamento dos dados de confirmação. |
| CREDIT_CONTRACT_LIMIT_REDUCTION_NOT_COMMUNICATED | Evento final que indica que parceiro não conseguiu realizar a comunicação com o cliente para aplicação da redução de limite do contrato de credito. Neste caso a solicitação ainda se mantém válida até que atinja a data de expiração, permitindo assim futuras tentativas de comunicação. |
| CREDIT_CONTRACT_LIMIT_INCREASE_REJECTED | Evento final que indica que parceiro informou que o cliente rejeitou a oferta de aumento de limite do contrato de credito. Neste caso a solicitação ainda se mantém válida até que atinja a data de expiração, permitindo assim futuras tentativas de comunicação. |
| CREDIT_CONTRACT_LIMIT_INCREASE_ACCEPTED | Evento final que indica que a o limite foi aumentado com sucesso. |
| CREDIT_CONTRACT_LIMIT_REDUCTION_APPLIED | Evento final que indica que a o limite foi reduzido com sucesso. |
