Alterar uma retenção

patch https://sandbox.auth.flowfinance.com.br/accounts/{account_id}/deposit-retention/{deposit_retention_id}

Esse endpoint permite a alteração de uma regra de retenção previamente cadastrada na Conta.

Regras para edição:

Só é possível editar uma retenção que esteja nos status 'CREATED' ou 'ACTIVE'.
Não é possível reduzir o 'valor máximo retido' para um valor que fique menor do que o valor retido atualmente.

Parâmetros da URL

account_id (string): ID de cadastro da Conta.
deposit_retention_id (string): ID de cadastro da retenção a ser editada.

Parâmetros da Requisição

name (string, obrigatório): O nome para identificação da regra.
startDate (string, obrigatório): Data de inicio para aplicação da regra de retenção na conta. Após essa data a retenção estará "ATIVA" e irá ser aplicada até a data final.
endDate (string, obrigatório): Data final para encerramento da regra de retenção. Após essa data a retenção não será mais aplicada e todo valor transacionado será enviado para a conta destinatária indicada via PIX (gerando tarifa normalmente).
amountPercentage (float, obrigatório): Valor percentual a ser aplicado na retenção dos valores transacionados.
origins (array, obrigatório): Lista de CPFs ou CNPJs para aplicar a regra de retenção. Se informada uma lista a regra de retenção só será aplicada se for transacionada por esses números de documentos.
shouldRetainSlc (boolean, obrigatório): Flag para indicar se a retenção também será aplicada em depósitos do tipo SLC, com as mesmas regras de PIX e TED.
accountDestination (string/uuid, obrigatório): ID de identificação da conta beneficiária, ou seja, conta que irá receber os valores retidos.
description (string): Descrição para detalhamento da regra e condições da retenção.
maxAmount (float): Valor máximo a ser retido. Deve ser estipulado um valor máximo que será retido na retenção cadastrada. Ao atingir esse valor a retenção automaticamente será bloqueada até a data final configurada.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e em caso de algum erro será retornado um status 40X e uma mensagem informando o motivo.