PesquisarClienteBasico (Obter apenas dados básicos do cliente)
O que este método faz:
Obtém apenas dados básicos do cabeçalho e linhas de contratos (CREDITS) da página inicial do cliente.
Obs: Este método traz apenas dados bem básicos, e por isso retorna de maneira mais rápida, caso necessite de dados mais completos, utilize o outro método de PesquisarCliente.
Request:
Endpoint: /v1/engage/PesquisarClienteBasico
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": "de Assis Ana Maria",
"nombreLegal": "Ana Maria de Assis",
"idUsuario": "1111111111",
"persona": "PERSON",
"email": "ana@email.com",
"tipoUsuario": "MERCHANT",
"nick": "ANA2022",
"custPKey": "B7BBC5E6-86B8-4B0D-8F50-D1045A50C7A0",
"cpf": "98765432100",
"diasAtraso": 177,
"dividaVencida": 1948.65,
"dividaTotal": 1948.65,
"dividaVencidaDetalhes": {
"emprestimos": 1848.65,
"emprestimo_Consumer": 1848.65,
"emprestimo_Merchant": 0.00,
"emprestimo_Point": 0.00,
"emprestimo_Refi": 0.00,
"cartaoDeCredito": 100.0,
"ppv": 0.00,
"crossMeli": 0.00,
"prendarios": 0.00,
"parcelamentos": 0.00
},
"dividaTotalDetalhes": {
"emprestimos": 1848.65,
"emprestimo_Consumer": 1848.65,
"emprestimo_Merchant": 0.00,
"emprestimo_Point": 0.00,
"emprestimo_Refi": 0.00,
"cartaoDeCredito": 100.0,
"ppv": 0.00,
"crossMeli": 0.00,
"prendarios": 0.00,
"parcelamentos": 0.0
},
"diasAtrasoDetalhes": {
"emprestimos": 177,
"emprestimo_Consumer": 238,
"emprestimo_Merchant": 0,
"emprestimo_Point": 0,
"emprestimo_Refi": 0,
"cartaoDeCredito": 50,
"ppv": 0,
"crossMeli": 0,
"prendarios": 0,
"parcelamentos": 0
},
"produtosAtraso": 3,
"parcelasMora": 6,
"marcaRisco": "RISK_2",
"ultimoPagamento": "2022-11-07T00:00:00",
"codigoPagoUnico": "0",
"situacaoAtividade": "NO CONTACTADO",
"situacaoLocalizacao": "CON DATOS",
"situacaoDivida": "EN MORA",
"segmento": "TARDIA ",
"atribuidoA": "Assessoria - ...",
"proximaAcao": "2023-06-02T00:00:00",
"promessas": {
"vigentes": 0,
"cumpridas": 0,
"naoCumpridas": 1
},
"contratos": [
{
"detProduto": "Merchant",
"categoria": "Merchant",
"id": "EXPRESS_POINT_MLB_1",
"nro": "310699940",
"jaEstaEmParcelamento": false,
"documento": "98765432100",
"dataAlta": "2022-11-08T00:00:00",
"estado": "Vencido",
"dividaVencida": 888.27,
"dividaTotal": 888.27,
"atraso": 177,
"parcelas": 1,
"parcelasTotales": 1,
"lerVencNaoPagamento": "2022-12-06T00:00:00",
"ultimoPagamento": " (0.00)",
"proximaExpiracao": " (0.00)",
"fpd": "SI",
"scoreRisco": "C153",
"cotasProduto": []
},
{
"detProduto": "Merchant",
"categoria": "Point",
"id": "POINT_MLB_1",
"nro": "293636940",
"jaEstaEmParcelamento": false,
"documento": "98765432100",
"dataAlta": "2022-10-08T00:00:00",
"estado": "Vencido",
"dividaVencida": 960.38,
"dividaTotal": 960.38,
"atraso": 175,
"parcelas": 5,
"parcelasTotales": 6,
"lerVencNaoPagamento": "2022-12-08T00:00:00",
"ultimoPagamento": "07/11/22 (107.73)",
"proximaExpiracao": " (0.00)",
"fpd": "NO",
"scoreRisco": "H153",
"cotasProduto": []
},
{
"detProduto": "Merchant",
"categoria": "Merchant",
"id": "EXPRESS_POINT_MLB_1",
"nro": "310134890",
"jaEstaEmParcelamento": false,
"documento": "98765432100",
"dataAlta": "2022-11-07T00:00:00",
"estado": "Cancelado",
"dividaVencida": 0.00,
"dividaTotal": 0.00,
"atraso": 0,
"parcelas": 0,
"parcelasTotales": 1,
"lerVencNaoPagamento": null,
"ultimoPagamento": " (0.00)",
"proximaExpiracao": " (0.00)",
"fpd": "NO",
"scoreRisco": "C153",
"cotasProduto": []
}
],
"contratosPPV": null,
"contratosCrossMeli": null,
"cartoesDeCredito": null,
"historicoAcordos": null,
"historicoPromessas": null,
"historicoPagamentos": null,
"historicoParcelamentos": null,
"historicoAgreements": null,
"telefonesAlternativos": null,
"verMais": null
}
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)
Obs: Os seguintes campos (Que vem com valor null no final do exemplo acima) virão sempre null nesta chamada de Api. (Caso precise deles preenchidos, é necessário utilizar o outro método PesquisarCliente que traz dados mais completos):
- contratosPPV
- contratosCrossMeli
- cartoesDeCredito
- historicoAcordos
- historicoPromessas
- historicoPagamentos
- historicoParcelamentos
- historicoAgreements
- telefonesAlternativos
- verMais
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)"
Caso houver algum outro erro, ele também virá como Bad Request trazendo alguma mensagem de texto.