PesquisarCliente (Obter dados do cliente)
O que este método faz:
Obtém os dados do cabeçalho, contratos Credits, Cross Meli, PPV (quando disponíveis), cartão de crédito (e parcelas dele caso disponível), históricos de promessas, acordos e parcelamentos, e etc, da página inicial do cliente.
Obs: Este método traz dados mais completos do cliente, mas caso queira trazer apenas dados bem básicos de maneira mais rápida, é possível utilizar o outro método de PesquisarClienteBasico.
Request:
Endpoint: /v1/engage/PesquisarCliente
Método: POST
Parametros via Body:
{
"documento": "123456789",
"usuarioLogin": {
"user": "string",
"password": "string"
}
}
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 |
Response:
{
"nome": "Menezes Carlos",
"nombreLegal": "Carlos Menezes",
"idUsuario": "88888888",
"persona": "PERSON",
"email": " carlos@gmail.com",
"tipoUsuario": "CONSUMER",
"nick": "CARLOOOS",
"custPKey": "4A050DAB-05DC-4B02-9280-3E7662436A28",
"cpf": "123456789",
"diasAtraso": 238,
"dividaVencida": 2313.52,
"dividaTotal": 2313.52,
"dividaVencidaDetalhes": {
"emprestimos": 1459.00,
"emprestimo_Consumer": 1459.00,
"emprestimo_Merchant": 0.00,
"emprestimo_Point": 0.00,
"emprestimo_Refi": 0.00,
"cartaoDeCredito": 854.17,
"ppv": 0.00,
"crossMeli": 0.00,
"prendarios": 0.00,
"parcelamentos": 0.00
},
"dividaTotalDetalhes": {
"emprestimos": 2000.00,
"emprestimo_Consumer": 1459.00,
"emprestimo_Merchant": 0.00,
"emprestimo_Point": 0.00,
"emprestimo_Refi": 0.00,
"cartaoDeCredito": 854.17,
"ppv": 0.00,
"crossMeli": 0.00,
"prendarios": 0.00,
"parcelamentos": 0.0
},
"diasAtrasoDetalhes": {
"emprestimos": 238,
"emprestimo_Consumer": 238,
"emprestimo_Merchant": 0,
"emprestimo_Point": 0,
"emprestimo_Refi": 0,
"cartaoDeCredito": 188,
"ppv": 463,
"crossMeli": 265,
"prendarios": 0,
"parcelamentos": 0
},
"produtosAtraso": 4,
"parcelasMora": 6,
"marcaRisco": "E",
"ultimoPagamento": "2022-03-11T00:00:00",
"codigoPagoUnico": "",
"situacaoAtividade": "INACTIVO",
"situacaoLocalizacao": "CON DATOS",
"situacaoDivida": "EN MORA",
"segmento": "WRITE OFF ",
"atribuidoA": "ASSESSORIA - ...",
"proximaAcao": "2022-11-20T00:00:00",
"promessas": {
"vigentes": 0,
"cumpridas": 2,
"naoCumpridas": 2
},
"contratos": [
{
"detProduto": "CONSUMER",
"categoria": "CONSUMER",
"id": "PER_CON_MLB_1",
"nro": "181424680",
"jaEstaEmParcelamento": false,
"documento": "123456789",
"dataAlta": "2022-03-10T03:00:00",
"estado": "Vencido",
"dividaVencida": 399.41,
"dividaTotal": 399.41,
"atraso": 238,
"parcelas": 1,
"parcelasTotales": 1,
"lerVencNaoPagamento": "2022-03-28T00:00:00",
"ultimoPagamento": " (399.41)",
"proximaExpiracao": " (0.00)",
"fpd": "SI",
"scoreRisco": "Z500",
"cotasProduto": []
},
{
"detProduto": "CONSUMER",
"categoria": "CONSUMER",
"id": "PER_CON_MLB_1",
"nro": "181884427",
"jaEstaEmParcelamento": false,
"documento": "123456789",
"dataAlta": "2022-03-11T03:00:00",
"estado": "Vencido",
"dividaVencida": 807.40,
"dividaTotal": 807.40,
"atraso": 238,
"parcelas": 4,
"parcelasTotales": 4,
"lerVencNaoPagamento": "2022-03-28T00:00:00",
"ultimoPagamento": " (184.09)",
"proximaExpiracao": " (0.00)",
"fpd": "SI",
"scoreRisco": "Z500",
"cotasProduto": []
},
{
"detProduto": "CONSUMER",
"categoria": "CONSUMER",
"id": "PER_CON_MLB_1",
"nro": "155845940",
"jaEstaEmParcelamento": false,
"documento": "123456789",
"dataAlta": "2022-01-17T03:00:00",
"estado": "Vencido",
"dividaVencida": 252.54,
"dividaTotal": 252.54,
"atraso": 207,
"parcelas": 1,
"parcelasTotales": 4,
"lerVencNaoPagamento": "2022-04-28T00:00:00",
"ultimoPagamento": "11/03/22 (252.54)",
"proximaExpiracao": " (0.00)",
"fpd": "NO",
"scoreRisco": "Z500",
"cotasProduto": []
},
{
"detProduto": "CONSUMER",
"categoria": "CONSUMER",
"id": "PER_CON_MLB_1",
"nro": "149071825",
"jaEstaEmParcelamento": false,
"documento": "123456789",
"dataAlta": "2022-01-02T03:00:00",
"estado": "Finalizado",
"dividaVencida": 0.00,
"dividaTotal": 0.00,
"atraso": 0,
"parcelas": 0,
"parcelasTotales": 2,
"lerVencNaoPagamento": null,
"ultimoPagamento": "10/03/22 (0.00)",
"proximaExpiracao": " (0.00)",
"fpd": "NO",
"scoreRisco": "Z500",
"cotasProduto": []
}
],
"contratosPPV": [
{
"produto": "MERCHANT",
"categoria": "PPV",
"id": "SPL_POINT_MLB_FO_1",
"nro": "22277200",
"dataAlta": "2021-08-13T00:00:00",
"estado": "Vencido",
"dividaVencida": 12240.00,
"dividaTotal": 17279.92,
"atraso": 463,
"parcelasDevidas": 17.00,
"vencNaoPagamento": "2021-09-13T00:00:00",
"porcentagemReembolso": 0.00,
"valorTotalEmprestimo": 17279.92,
"valorTotalPago": 0.00,
"porcentagemDevido": 100.00,
"scoreRisco": "G108"
}
],
"contratosCrossMeli": [
{
"tipo": "CBK",
"produto": "AGGREGATOR-AGGREGATOR - OTHER",
"nro": "32008273",
"dataDaAlta": "2023-01-31T00:00:00",
"doenca": "OVERDUE",
"fechaDeRegularizacao": null,
"dividaVencida": 1041.61,
"atraso": 265,
"primeiroVencNaoPagamento": "2022-05-11T00:00:00",
"tipoDeGrupo": "",
"descricaoDaOperacao": "QUEROPASSAGEM COMPRA 3367575 ",
"status": "",
"pagarCheque": "",
"dividaAutomatica": "",
"cartaoDeDescricao": "CREDIT_CARD",
"diaDoPagamento": "2022-05-03T00:00:00"
"linkRepago": "https://www.mercadopago.com.br/checkout/v1/redirect?pref_id=123-abc123-abc123-abc123-abc123-abc123"
}
],
"cartoesDeCredito": [
{
"dataDeFechamento": "2022-07-07T00:00:00",
"dataDeExpiracao": "2022-07-17T00:00:00",
"taxa": 15.00,
"pagamentoMinimo": 528.72,
"compulsorio": "NO",
"diferencaMinimaDePagamento": 0.0,
"montanteDoResumo": 854.17,
"diferencaMontanteDoResumo": 0.0,
"estadoDeConta": "Mora tardia",
"garantia": "N/A",
"diasDeAtraso": 188,
"opcoesParcelamentoAcordo": [
{
"montanteTotal": 384.38,
"numeroParcelas": 1,
"montanteParcela": 0.00,
"montanteDesconto": 469.79,
"hash": "ca64979e-5a59-4d60-8e15-18ced5c3ae13"
},
{
"montanteTotal": 512.50,
"numeroParcelas": 3,
"montanteParcela": 170.84,
"montanteDesconto": 341.67,
"hash": "6c42e209-d246-4c9c-84ac-e5612206eda1"
},
{
"montanteTotal": 597.92,
"numeroParcelas": 6,
"montanteParcela": 99.66,
"montanteDesconto": 256.25,
"hash": "7b28fe0e-5cac-4cb5-b6ff-78c0871a4e2c"
},
{
"montanteTotal": 683.34,
"numeroParcelas": 9,
"montanteParcela": 75.93,
"montanteDesconto": 170.83,
"hash": "dc434de9-a868-491c-a8a5-4387a1644c4f"
},
{
"montanteTotal": 768.75,
"numeroParcelas": 12,
"montanteParcela": 64.06,
"montanteDesconto": 85.42,
"hash": "983a98d0-74ea-42cf-b008-df6b8a29fea0"
}
]
}
],
"historicoAcordos": [
{
"estado": "Não cumprido",
"dataDeAlta": "2022-11-11T10:28:22",
"montante": 589.03,
"numeroParcelas": 3,
"proximoPagamento": "2022-11-12T00:00:00",
"montanteParcela": 196.33,
"usuarioAlta": "ASSESSORIA397",
"unidadeAlta": "ASSESSORIA"
}
],
"historicoPromessas": [
{
"id": "12294888",
"estado": "EN CURSO",
"dataDeAlta": "2022-11-19T10:29:51",
"montante": 196.36,
"dataDePagamento": "2022-19-12T00:00:00",
"dataDeValidade": "2022-19-16T00:00:00",
"canalDePagamento": "Pix",
"tipo": "CREDITS",
"usuarioAlta": "ASSESSORIA0001",
"unidadeAlta": "ASSESSORIA"
},
{
"id": "12294777",
"estado": "INCUMPLIDA",
"dataDeAlta": "2022-11-11T10:29:51",
"montante": 196.36,
"dataDePagamento": "2022-11-12T00:00:00",
"dataDeValidade": "2022-11-16T00:00:00",
"canalDePagamento": "Boleto (Bradesco)",
"tipo": "CREDITS",
"usuarioAlta": "ASSESSORIA0001",
"unidadeAlta": "ASSESSORIA"
},
{
"id": "3468051",
"estado": "CUMPLIDA",
"dataDeAlta": "2021-09-03T09:39:54",
"montante": 20.22,
"dataDePagamento": "2021-09-04T00:00:00",
"dataDeValidade": "2021-09-05T00:00:00",
"canalDePagamento": "Lotérica",
"tipo": "CREDITS",
"usuarioAlta": "Autogestión",
"unidadeAlta": "Autogestión"
}
],
"historicoPagamentos": [
{
"nroPagamento": "22147356706",
"dataPagamento": "2022-05-06T16:37:10",
"montanteTotal": 121.89,
"montanteNoCapital": 0.00,
"moeda": "BRL",
"canalDePagamento": "pec",
"nroCota": "",
"nroProduto": ""
},
{
"nroPagamento": "20784854229",
"dataPagamento": "2022-03-11T12:50:37",
"montanteTotal": 111.97,
"montanteNoCapital": 12.31,
"moeda": "BRL",
"canalDePagamento": "pec",
"nroCota": "428686127",
"nroProduto": "172762206"
},
{
"nroPagamento": "20763904097",
"dataPagamento": "2022-03-10T17:20:37",
"montanteTotal": 152.89,
"montanteNoCapital": 29.04,
"moeda": "BRL",
"canalDePagamento": "pec",
"nroCota": "358064076",
"nroProduto": "144384966"
}
],
"historicoParcelamentos": [
{
"id": "16186",
"dataDeAlta": "2023-01-10T10:52:59",
"dataDeExpiracao": "2023-01-11T00:00:00",
"estado": "Criado",
"montante": 22.72,
"montantePagado": 0.00,
"cantParcelas": "1",
"cantProdutos": "3",
"desconto": 84.47,
"usuarioAlta": "novaquest_sup",
"unida": "Novaquest"
},
{
"id": "13394",
"dataDeAlta": "2023-01-06T16:16:36",
"dataDeExpiracao": "2023-01-10T00:00:00",
"estado": "Anulado",
"montante": 22.72,
"montantePagado": 0.00,
"cantParcelas": "1",
"cantProdutos": "3",
"desconto": 84.47,
"usuarioAlta": "novaquest_sup",
"unida": "Novaquest"
}
],
"historicoAgreements": [
{
"id": "7594807",
"valorDaDividaOriginal": 102.19,
"descontoTotal": 50.07,
"quantidadeFinal": 52.12,
"quotas": "1",
"valorDaCota": 52.12,
"dataDaPrimeiraCota": "2022-12-16T00:00:00",
"moeda": "Real",
"doenca": "INCUMPLIDO"
}
]
}
Legenda de alguns parâmetros do RESPONSE:
nombreLegal: Nome do cliente no padrão brasileiro (primeiro nome + sobrenome)
diasAtraso: Quantidade de dias atrasados da divida vencida do cliente
produtosAtraso: Quantidade de contratos e cartões (quando houver) em atraso.
dividaVencidaDetalhes: Detalhe da dívida vencida de cada categoria de produto.
dividaTotalDetalhes: Detalhe da dívida total de cada categoria de produto.
diasAtrasoDetalhes: Detalhe dos dias de atraso de cada categoria de produto.
promessas: objeto que carrega a situação das promessas:
vigentes: promessas ativas
cumpridas: promessas que o cliente já fechou e pagou
naoCumpridas: promessas que foram feitas mas não foram pagas
contratos: Lista de contratos/empréstimos do cliente [cartão não incluso]
nro: número do contrato
jaEstaEmParcelamento: indica se o contrato já está dentro de algum parcelamento ativo
documento: Cpf do cliente
dataAlta: data do vencimento
estado: status atual do contrato ("Vencido", "Finalizado", etc)
dividaVencida: valor vencido do contrato
atraso: dias de atraso do contrato (zero significa que está em dia)
contratosPPV: Lista de contratos da categoria PPV
contratosCrossMeli: Lista de contratos da categoria Cross Meli (CBK)
Obs: o campo "linkRepago" retornará o link de pagamento daquela compra (caso o link estiver disponível no Engage, do contrário retornará null).
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)
numeroParcelas: quantidade de vezes a parcelar
montanteParcela: valor da parcela
montanteDesconto: o desconto que o Engage deu no montanteTotal
Erros possíveis:
Bad Request: "Nenhum cliente foi localizado para o documento: xxxxxxxxx (CPF:xxxxxxxxx)"
Bad Request: "Erro ao efetuar login, verifique os dados e tente novamente! (CPF:xxxxxxxxx)"
Bad Request: "Instabilidade no site do Engage/Mercado Livre. (CPF:xxxxxxxxx)"
Bad Request: "Instabilidade na VPN ou no site do Engage. (CPF:xxxxxxxxx)"
Bad Request: "Erro ao efetuar login, O usuário {user} já possui sessões abertas no módulo AGENTE."
Bad Request: "Erro ao efetuar login, Usuário {user} e ou senha inválidos"
Bad Request: "Erro ao efetuar login, Usuário {user} bloqueado ou expirado"
Bad Request: "Erro ao efetuar login, Usuário {user} está pedindo renovação de senha"
Bad Request: "Erro ao efetuar login, verifique os dados e tente novamente!. (login engage:{user})"
Caso houver algum outro erro, ele também virá como Bad Request trazendo alguma mensagem de texto.