API de limpeza de transação Zoop em parcelas de acordo

A API de limpeza de transação Zoop em parcelas de acordo pode ser útil para cancelar o registro de um boleto ou cancelar um QR Code PIX para viabilizar a geração de um novo meio de pagamento para uma parcela de um acordo informada como parâmetro. Isso também pode ser importante para permitir o cancelamento de um acordo com transação Zoop pendente.

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

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,
   id_contasareceber: int, 
   id_transacao_zoop: 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.
• ID Contas a Receber: código da parcela do acordo. Este campo é obrigatório.
• ID da transação Zoop: código da transação gerada pela Zoop. Este campo é obrigatório.

Classe de retorno

{

   sucesso: bool,
   mensagem: string
   parcela_acordo: objeto com informações sobre parcela afetada pela limpeza de transação informada como parâmetro

}

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.
• parcela_acordo: ver a descrição do objeto em API para listagem de acordos feitos via portal de negociação.