---
title: "Cadastrar uma retenção"
method: POST
path: "/escrow/api/v1/accounts/{account_id}/deposit-retention"
tags: ["Contas > Retenção"]
---

# Cadastrar uma retenção

`POST /escrow/api/v1/accounts/{account_id}/deposit-retention`

Esse endpoint permite o cadastro de uma regra de retenção para fazer um bloqueio automático de valores em uma conta.

#### Parâmetros da URL

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

#### 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 um ID da retenção configurada:

- `id` (string/uuid): ID da retenção cadastrada.

## Path parameters

- `account_id` string, required

## Headers

- `Content-Type` string
- `Accept` string

## Request body

- object

## Response `200`

OK

- object

## Other responses

- `400` — Bad Request
- `403` — Forbidden

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)