API para cadastro de acordo de forma semelhante ao portal de negociação

De Recuperador CRM | Documentação
Ir para: navegação, pesquisa

A API de cadastro de acordos de forma semelhante ao portal de negociação deve ser utilizada para registrar um acordo no Recuperador CRM seguindo o formato do portal de negociação, ou seja, deverá ser informado o parcelamento desejado e o sistema efetuará o acordo como sendo um acordo feito pelo portal de negociação. Isso é bastante útil para utilizar a funcionalidade do portal de negociação do Recuperador CRM em formato white label.


Endpoint: https://www.recuperador.com.br/api/v1PortalNegociacao

Ação: POST

Formato: JSON

Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.


Objeto de entrada

{

   id_contasareceber: int,
   id_credor: int,
   id_cliente: int,
   parcelas: int,
   cpf_cnpj_formatado: string

}

Seguem informações complementares sobre cada coluna do objeto:


Classe de retorno

{

   sucesso: bool,
   mensagem: string

}

Seguem informações complementares sobre cada coluna do objeto:

  • Sucesso: retornará true em caso de acordo realizado com sucesso e false em caso de erro na chamada.
  • Mensagem: exibirá a mensagem de sucesso ou de erro. Em caso de sucesso, será exibido o link da fatura, que é o link que o devedor deverá acessar para conferir as parcelas geradas, bem como para gerar os boletos ou para permitir o pagamento via cartão de crédito, dependendo da configuração do cadastro do credor.


Conforme dito anteriormente, esta API serve para registrar o acordo no Recuperador CRM. Porém, antes disso, é necessário exibir o valor atualizado da dívida, eventuais taxas e exibir o valor com desconto para pagamento à vista. Tais valores podem ser obtidos na API de listagem de valores do portal de negociação.