Aceite do novo limite de contrato de crédito
stable
Após o pedido de reanálise ser aprovado, o cliente do parceiro deverá aceitar a nova proposta de limite de contrato de crédito.
Este endpoint permite enviar o aceite do cliente para que seja possível realizar a emissão do novo contrato.
Pré-requisitos
Para que seja possível utilizar este endpoint, é necessário que:
- O pedido de reanálise de crédito tenha sido aprovado;
- O cliente do parceiro tenha assinado o novo termo de aceite da proposta do contrato de crédito.
Requisição (Request)
Requisição HTTP
PUT https://api-mtls.sandbox.bankly.com.br/cards/credits/document/{documentNumber}/contract/{contract}/acceptance \
--request PUT \
--url 'https://api-mtls.sandbox.bankly.com.br/cards/credits/document/47742663023/contract/{contract}/acceptance' \
--header 'Authorization: Bearer' \
--header 'accept: application/json' \
--header 'api-version: 1' \
--header 'content-type: application/json' \
--data '
{
"trace": [
{
"date": "2022-03-16T18:48:07.714Z",
"state": "Assinatura de contrato"
}
],
"userInfo": {
"address": "Rua 6 de Março, 2500 Alter do Chão, Santarém - PA 68060-100",
"customerId": "987654321",
"mail": "[email protected]",
"name": "Nísia Floresta",
"phone": "23415162342"
},
"authorization": "tokenAssinatura",
"idState": "123456789",
"token": "tokenConfirmacao",
"terms": "texto"
}
'
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 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. |
contract | path | Número do contrato de crédito do cliente. | — |
Corpo da requisição (Body)
No body, envie os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
authorization | string | Obrigatório. Token que o cliente utilizou na assinatura eletrônica, o qual comprova a sua autenticação no site. |
idState | string | Obrigatório. Identificador do contrato, gerado em sua criação. |
token | string | Obrigatório. Token de SMS/e-mail que confirma a identidade do usuário que assinou o aceite. |
terms | string | Obrigatório. Insira o texto do contrato que foi aceito pelo cliente. Sugestão: pode-se remover as quebras de linha e enviar o texto corrido do aceite. |
trace | array of bjects | Obrigatório. Objeto que contém a lista de dados de rastreio do usuário solicitante. |
trace.state | string | Obrigatório. Log de navegação do cliente nas telas do frontend, desde o login até a tela de aceite. |
trace.date | string | Obrigatório. Data do aceite, no formato ISO 8601 - UTC. |
userInfo | object | Obrigatório. Objeto que contém os dados do cliente beneficiário do contrato. |
userInfo.address | string | Obrigatório. Endereço completo do cliente. |
userInfo.customerId | string | Obrigatório. Identificador do cliente determinado pelo parceiro. |
userInfo.mail | string | Obrigatório. E-mail do cliente. |
userInfo.name | string | Obrigatório. Nome completo do cliente |
userInfo.phone | string | Obrigatório. Número de telefone do cliente, com DDD. |
{
"trace": [
{
"date": "2022-03-16T18:48:07.714Z",
"state": "Assinatura de contrato"
}
],
"userInfo": {
"address": "Rua 6 de Março, 2500 Alter do Chão, Santarém - PA 68060-100",
"customerId": "987654321",
"mail": "[email protected]",
"name": "Nísia Floresta",
"phone": "23415162342"
},
"authorization": "tokenAssinatura",
"idState": "123456789",
"token": "tokenConfirmacao",
"terms": "texto"
}
Resposta (Response)
O status code 202 indicará que o aceite da nova proposta do contrato de crédito foi enviado com sucesso.
Dica
Para 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
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 |
|---|---|
| CREDIT_CARD_LIMIT_INCREASE_ACCEPTED | O aumento do limite de crédito foi aceito. Este evento sinaliza que o cliente aceitou o aumento de limite de crédito e assinou o contrato. |
Updated about 1 month ago