InserirAcordoParcelamentoCartao - Parcelar cartão de crédito (Acuerdo)
O que este método faz:
Insere um acordo de parcelamento da dívida do cartão de crédito (quando houver).
Cartões de crédito com menos de 66 dias de atraso não podem ser parcelados (O próprio Engage impede a geração do acordo).
Print da tabela de opções de parcelamento do cartão ("Acuerdo" no site)
PASSO INICIAL: OBTENDO OS VALORES DE PARCELAMENTO:
Na API, ao chamarem o método de PesquisarCliente, a lista das opções de parcelamento se encontrará em “opcoesParcelamentoAcordo”, que fica dentro do objeto “cartoesDeCredito”:
Print do retorno da API:
Legenda dos campos do print acima:
cartoesDeCredito: Objeto que carrega a lista com os dados do cartão de credito
dataDeExpiracao: data de expiração
pagamentoMinimo: divida vencida do cartão (este valor que se soma àquele campo dividaVencida visto anteriormente)
montanteDoResumo": total devido no cartão
diasDeAtraso: dias de atraso do cartão (zero significa que está em dia)
opcoesParcelamentoAcordo: Lista de opções de parcelamento do cartão (lista vazia significa que não há opção para parcelar)
montanteTotal: valor total a ser pago (já com desconto aplicado)
numeroParcelas: quantidade de vezes a parcelar
montanteParcela: valor da parcela
montanteDesconto: valor do desconto que foi abatido em cima do montanteTotal
Observações Importantes:
Obs 1: No momento, o Engage só libera a opção de parcelamento para clientes com 66 dias ou mais de atraso no cartão, menos do que isso, as opções de parcelamento nem são visíveis e a lista de opcoesParcelamentoAcordo ficará vazia no retorno da API.
Obs 2: O número de parcelas disponíveis são pré fixadas no site, no momento são de 1, 3, 6, 9 e 12 vezes.
Obs 3: Observe que na opção de parcelar em 1x, o retorno mostra o campo montanteParcela como zero, já que o cliente deve pagar o montanteTotal todo de uma vez (Trazemos os valores da mesma forma que são mostrados no Engage).
PASSO FINAL: GERANDO ACORDO
Depois de escolhida a opção de parcelamento, basta chamar o metodo InserirAcordoParcelamentoCartao
Request:
Endpoint: /v1/engage/InserirAcordoParcelamentoCartao
Método: POST
Parametros via Body:
{
"documento": "string",
"usuarioLogin": {
"user": "string",
"password": "string"
},
"dataPagamento": "yyyy-MM-dd",
"numeroParcelas": 0,
"observacao": "string",
"telefone": "string",
"gravarTelefone": true
}
Legenda dos parâmetros:
| parâmetro | tipo | descrição |
documento |
string |
Cpf do cliente a ser pesquisado |
usuarioLogin.user |
string |
Usuário do site Engage do MercadoPago |
usuarioLogin.password |
string |
Senha do usuário do site Engage do MercadoPago |
dataPagamento |
DateTime |
Data de vencimento para o cliente pagar a primeira parcela (formato yyyy-MM-dd) |
numeroParcelas |
int |
Numero de vezes a parcelar, de acordo com opção escolhida anteriormente. |
telefone |
string |
Telefone do cliente |
gravarTelefone |
boolean |
(opcional) true= Grava telefone do cliente no site Engage. false = não grava |
observacao |
string |
Texto para ser gravado na ocorrência no site do Engage |