API de cancelamento de acordo

Revisão de 17h13min de 11 de maio de 2026 por Suporte (discussão | contribs) (Criou página com 'A API de cancelamento de acordo pode ser útil para liberar as dívidas de um acordo para serem negociadas em um novo acordo. Endpoint: https://app.recuperador.com.br/api/v1...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

A API de cancelamento de acordo pode ser útil para liberar as dívidas de um acordo para serem negociadas em um novo acordo.


Endpoint: https://app.recuperador.com.br/api/v1CancelarAcordo

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.


Parâmetros de entrada

{

   id_credor: int,
   id_acordo: int,
   id_cliente: int,
   cancelar_acordos_parcela_paga: string,
   limpar_transacao_auto: string,
   motivo_cancelamento: string

}

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

  • ID Credor: código do credor no Recuperador CRM. Este campo é obrigatório.
  • ID Acordo: código do acordo no Recuperador CRM. Este campo é obrigatório.
  • ID Cliente: código do devedor no Recuperador CRM. Este campo é obrigatório.
  • Cancelar acordos com parcela paga: informe S (maiúsculo) para Sim ou N (maiúsculo) para Não. Este campo é obrigatório.
  • Limpar transação automaticamente: informe S (maiúsculo) para Sim ou N (maiúsculo) para Não. Este campo é obrigatório.
  • Motivo do cancelamento: Este campo é obrigatório.


Classe de retorno

{

   sucesso: bool,
   mensagem: string

}


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

  • Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
  • Mensagem: exibirá a mensagem de sucesso ou de erro.