API de atualização de link de pagamento próprio

Revisão de 21h11min de 22 de junho de 2023 por Suporte (discussão | contribs)
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

A API de atualização de link próprio deve ser utilizada para enviar o link de pagamento gerado em um sistema de terceiros para o Recuperador CRM. Este recurso somente é válido para credores que utilizam o meio de pagamento Link Próprio.


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

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_credor: inteiro,
   id_cliente: inteiro, 
   id_acordo: inteiro,
   id_contasareceber: inteiro,
   uri_link_proprio: string    

}

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

  • ID Credor: código do credor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
  • ID Cliente: código do devedor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
  • ID Acordo: código do acordo no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
  • ID Contas a Receber: código (ID) da parcela no Recuperador CRM. Ele está presente no payload do Webhook de acordos na lista de parcelas.
  • URI Link Próprio: informe o endereço do link próprio de pagamento. Ele deve iniciar com http ou https, sendo https preferencialmente por segurança.


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.