Parcelamento de empréstimos (contratos Credits) - Como fazer

O que é o parcelamento de empréstimos:

É possível parcelar os empréstimos (contratos) no Engage, desde que eles se adequem nos requisitos abaixo:

• Se aplica partir de 90 dias de atraso

• Se aplica à Consumer, Merchant (Cota Fixa e Express), Point

Não está disponível para: PPV, TC, Cross Meli, Prendários e Clientes com Agreement ativo. E também não é possível gerar novo acordo caso já haja algum parcelamento ativo (status "Criado").

O histórico de Agreements e Parcelamentos pode ser visualizado no método PesquisarCliente.

O Engage inclui no cálculo todos os contratos que se adequam aos requisitos(é possível vê-los no método abaixo que traz a simulação), não é possível escolher somente um específico para negociar.

Prints do processo de Parcelamento de empréstimos no site do Engage

As opções para parcelar que podem aparecer disponíveis são 1, 3, 6, 9, 12, 18, 24 e 36 vezes, mas o Engage nem sempre oferece todas elas, pois ele faz um calculo levando em conta o quanto o cliente pode pagar por parcela, e o valor da dívida.

Para fazermos um parcelamento de empréstimos via API usaremos dois métodos:

ObterSimulacaoDeParcelamentoDosEmprestimos: Para obter as parcelas disponíveis.

InserirParcelamentoDosEmprestimos: Para tabular a proposta de parcelamento no site do Engage.

Veja a seguir como utilizar os métodos:

PASSO INICIAL: OBTENDO SIMULAÇÃO DOS VALORES DE PARCELAMENTO:

Este método serve para obter uma simulação dos valores para o parcelamento, é necessário saber quanto o cliente pode pagar por parcela antes de chamar este método, pois o valor por parcela interfere nas opções e condições que o Engage vai oferecer para o parcelamento.

Obs: O Mecado livre instruiu que o mínimo que deve ser sugerido a pagar por parcela é R$100 

Request:

Endpoint: /v1/engage/ObterSimulacaoDeParcelamentoDosEmprestimos 

Método: POST

Parametros via Body:

{
  "documento": "string",
  "usuarioLogin": {
    "user": "string",
    "password": "string"
  },
  "dataPagamento": "yyyy-MM-dd",
  "valorDaParcelaSugeridoPeloCliente": 0.0
}

Legenda dos parâmetros:

Response:

{
    "documento": "999999999999",
    "valorDaParcelaSugeridoPeloCliente": 100.00,
    "dataPagemento": "2023-01-13T00:00:00",
    "produtosAssociados": [
        {
            "id": "2224108960",
            "tipo": "Préstamo",
            "subTipo": "Consumer",
            "dividaOriginal": 720.20
        },
        {
            "id": "2437555300",
            "tipo": "Préstamo",
            "subTipo": "Merchant",
            "dividaOriginal": 30.21
        }
    ],
    "opcoesParcelamentoEmprestimos": [
        {
            "valorDaDividaOriginal": 734.47,
            "quantidadeDeParcelas": 3,
            "desconto": 463.45,
            "valorDaDividaComDesconto": 271.02,
            "valorDaParcela": 90.34,
            "hash": "000"
        },
        {
            "valorDaDividaOriginal": 734.47,
            "quantidadeDeParcelas": 1,
            "desconto": 471.53,
            "valorDaDividaComDesconto": 262.94,
            "valorDaParcela": 262.94,
            "hash": "000"
        }
    ]
}

No Response acima temos a lista de produtos Associados (produtosAssociados) que nos mostra quais contratos estão sendo negociados.

E temos a lista de opções de parcelamento (opcoesParcelamentoEmprestimos) que traz detalhes das opções que o cliente tem para negociar, e a quantidade de opções e valores podem mudar conforme o valor que o cliente estiver disposto a pagar por parcela (parametro valorDaParcelaSugeridoPeloCliente passado no request)

Caso não gerar simulação do acordo, retornará como status Bad Request e alguma mensagem de texto.

por exemplo:

"Não há contratos disponiveis para parcelamento (CPF:000000000)"
"Não há contratos disponiveis para parcelamento, pois já estão pagos em dia (CPF:000000000)"
"Não há contratos disponiveis para parcelamento, pois estão abaixo dos 90 dias de atraso (CPF:000000000)"
"Os contratos disponíveis ja estão dentro de algum Parcelamento (CPF:000000000)"

PASSO FINAL: GERANDO O ACORDO DE PARCELAMENTO:

Depois de escolhida a opção de parcelamento (no método anterior), use o método seguinte para efetivar a criação da proposta:

Request:

Endpoint: /v1/engage/InserirParcelamentoDosEmprestimos

Método: POST

Parametros via Body:

{
  "documento": "string",
  "usuarioLogin": {
    "user": "string",
    "password": "string"
  },
  "dataPagamento": "yyyy-MM-dd",
  "valorDaParcelaSugeridoPeloCliente": 0.0,
  "numeroParcelaEscolhida": 0,
  "telefone": "string",
  "gravarTelefone": true,
  "observacao": "string"
}

Legenda dos parâmetros:

Response

Caso gerar acordo com sucesso, o RESPONSE retornará como OK (status 200) e com um json similar ao do exemplo abaixo.

{
    "documento": "xxxxxxxxxx",
    "valorDaParcelaSugeridoPeloCliente": 10.00,
    "dataPagemento": "2023-01-13T00:00:00",
    "opcaoEscolhidaParcelamentoEmprestimo": {
        "valorDaDividaOriginal": 107.19,
        "quantidadeDeParcelas": 3,
        "desconto": 83.82,
        "valorDaDividaComDesconto": 23.37,
        "valorDaParcela": 7.79,
        "hash": "000"
    }
}

Caso não gerar acordo, retornará como status Bad Request e alguma mensagem de texto.