Updated: 10 January 2024

InserirPromessaPagamentoZerada - Promessa sem desconto (Quitação ou pagamento parcial, à vista)

O que este método faz:

Insere uma promessa de pagamento sem aplicar desconto. (Que pode ser quitação total ou pagamento parcial)

Não é possível inserir uma promessa nova caso já exista outra vigente (consulte o campo "vigentes" no artigo PesquisarCliente)

Obs: Produtos da gestão CREDITS e CROSS-MELI devem ser cobrados separadamente, para isto, use o campo 'gestao' nos parâmetros da chamada.


Request:

Endpoint: /v1/engage/InserirPromessaPagamentoZerada

Método: POST

Parametros via Body:

{
"documento": "string",
"usuarioLogin": {
  "user": "string",
  "password": "string"
},
"dataPagamento": "yyyy-MM-dd",
"canalPagamento": "string",
"montante": 0,
"gestao": "string",
"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

canalPagamento

string

Metodo de pagamento. Opções: "Dinheiro", "Boleto", "Loterica", "Pix"

dataPagamento

DateTime

Data de pagamento da promessa

telefone

string

Telefone do cliente

gravarTelefone

boolean

(opcional) true= Grava telefone do cliente no site Engage. false= não grava

montante

decimal

(opcional) valor parcial a ser pago (caso omitido, por padrão será considerado o valor da divida vencida no site do Engage). Veja mais detalhes sobre pagamento parcial no tópico de "Pagamento parcial"

gestao

string

(opcional) "CREDITS" ou "CROSS MELI". Default: "CREDITS" (veja mais detalhes abaixo)

observacao

string

Texto para ser gravado na ocorrência no site do Engage



Obs: O campo "gestao" serve para separar produtos "Credits" dos "Cross Meli", pois no Engage não é possivel inserir promessa de pagamento onde o valor destes dois tipos de produto estejam juntos. (Não dá pra cobrar Cross-Meli junto com Credits na mesma promessa de pagamento)

Por exemplo: Se o cliente dever R$500 de emprestimo, R$500 de cartão, e R$300 de Cross-Meli: 

- Você pode fazer uma chamada de Api para cobrar os R$1000 do empréstimo + cartão, passando o valor "CREDITS" no campo "gestao". 

- Ou então fazer uma chamada para cobrar os R$300 do Cross-Meli, passando o valor "CROSS MELI" no campo "gestao".

Caso não for passado o valor no campo "gestao", será considerado automaticamente como "Credits", caso o cliente tiver mais de uma opção, com exceção dos casos onde o cliente só tem a opção "Cross Meli" desbloqueada.

Se preferir, pode ser usado em conjunto o campo "montante" para cobrar exatamente o valor desejado (desde que não exceda o valor total de dívida da gestão em questão)

Response:

Caso inserir a promessa com sucesso, o RESPONSE retornárá como OK (status 200) e com um booleano 'true'.

Caso não inserir a promessa, retornará como status Bad Request e uma mensagem de texto em string.