Esse endpoint é responsável por retornar uma lista paginada de retenções cadastradas para uma determinada conta.

Parâmetros da URL

• account_id (string): ID de cadastro da conta a ser configurada.

Parâmetros da Requisição

• search (string): Busca textual no nome da retenção.

• sort (string): Campo para ordenação dos resultados. Possíveis valores: id, createdAt, status.

Resposta

Se a requisição for processada com sucesso será retornado um código 200 e um JSON no seguinte formato:

• content(object list): Objeto contendo a lista com o resultado do filtro realizado.

• hasNext (boolean): Campo para indicar se tem uma próxima página.

• totalElements (int): Quantidade total de registros retornados para a busca realizada.

• totalPages (int): Quantidade total de páginas retornadas para a busca realizada.

Objeto 'content'

• id (string/uuid): ID de cadastro da retenção.

• name (string): O nome para identificação da regra.

• status (string): Status atual da regra de retenção. Possíveis valores: CREATED, ACTIVE, REMOVED, ERROR

• startDate (string): 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): 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): Valor percentual a ser aplicado na retenção dos valores transacionados.

• origins (array): 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): 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.

• destination (object): Objeto contendo os dados da conta beneficiária, ou seja, conta que irá receber os valores retidos.

• createdAt (datetime): Data de cadastro da regra.

• 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.

• balanceRetention (object): Objeto contendo o saldo das retenções realizadas.

Objeto 'destination'

• id (string/uuid): Id de cadastro da conta beneficiária.

• bank (string): Código do banco.

• account (string): Número da conta

• branch (string): Número da agência.

• taxpayerId (string): Número do documento (CPF ou CNPJ) da conta de origem.

• name (string): Nome do titular da conta.

• type (string): Tipo da conta. Possíveis valores: CC - Conta Corrente; CI - Conta Investimento; PG - Conta de Pagamento; PP - Conta Poupança.

• key (string): Chave PIX

Objeto 'balanceRetention'

• id (string/uuid): Id da retenção.

• blockedAmount (float): Valor total retido.

Exemplo de JSON:

{
    "content": [
        {
            "id": "<string>",
            "name": "<string>",
            "status": "ERROR",
            "startDate": "<string>",
            "endDate": "<string>",
            "amountPercentage": "<number>",
            "origins": [
                "<string>",
                "<string>"
            ],
            "shouldRetainSlc": "<boolean>",
            "destination": {
                "id": "<string>",
                "taxpayerId": "<string>",
                "name": "<string>",
                "bank": "<string>",
                "branch": "<string>",
                "account": "<string>",
                "type": "<string>"
            },
            "createdAt": "<string>",
            "description": "<string>",
            "maxAmount": "<number>",
            "balanceRetention": {
                "id": "<uuid>",
                "blockedAmount": "<number>"
            }
        },
        {
            "id": "<string>",
            "name": "<string>",
            "status": "ACTIVE",
            "startDate": "<string>",
            "endDate": "<string>",
            "amountPercentage": "<number>",
            "origins": [
                "<string>",
                "<string>"
            ],
            "shouldRetainSlc": "<boolean>",
            "destination": {
                "id": "<string>",
                "taxpayerId": "<string>",
                "name": "<string>",
                "bank": "<string>",
                "branch": "<string>",
                "account": "<string>",
                "type": "<string>"
            },
            "createdAt": "<string>",
            "description": "<string>",
            "maxAmount": "<number>",
            "balanceRetention": {
                "id": "<uuid>",
                "blockedAmount": "<number>"
            }
        }
    ],
    "hasNext": "<boolean>",
    "totalElements": "<number>",
    "totalPages": "<number>"
}