v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Contas > Retenção

Excluir uma retenção

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

Após a exclusão de uma retenção, ela ficará no estado de "REMOVED" e todo dinheiro bloqueado será desbloqueado automaticamente.

Só é possível excluir retenções que estejam no status "ACTIVE" e "CREATED".

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.

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.

delete/escrow/api/v1/accounts/{account_id}/deposit-retention/{deposit_retention_id}

Path parameters

account_idstring required

deposit_retention_idstring required

Headers

Acceptstring

Response

object required