Liberação dos Valores em garantia

A liberação dos valores em garantia consiste em encerrar a retenção de uma cobrança na Conta Escrow, tornando o valor disponível no saldo da subconta.

Enquanto a garantia permanecer ativa, o valor continua bloqueado e não pode ser utilizado pela subconta. Após sua liberação, o recebimento passa a compor normalmente o saldo disponível.


Formas de liberação

Os valores podem ser liberados de três maneiras:

Liberação automática

Quando a data definida em expirationDate é atingida, a garantia é encerrada automaticamente e o valor passa a ficar disponível no saldo da subconta.

Esse comportamento ocorre sem necessidade de qualquer ação da integração.

Liberação manual via API

Caso seja necessário disponibilizar o valor antes do término do período de garantia, a integração pode realizar a liberação manual utilizando o endpoint específico da Conta Escrow.

Antes disso, é necessário recuperar os dados da garantia utilizando o endpoint Recuperar garantia da cobrança na Conta Escrow, pois ele retorna o identificador (id) utilizado para finalizar a garantia.

Depois de obter esse identificador, utilize:

POST /v3/escrow/{id}/finish
Confira a referência completa deste endpoint.

O parâmetro utilizado na URL corresponde ao identificador da garantia da Conta Escrow, e não ao identificador da cobrança.

🚧

Atenção

A liberação manual encerra imediatamente a garantia, independentemente da data configurada em expirationDate.

Após essa operação, o valor deixa de permanecer retido e passa a compor o saldo disponível da subconta.

Liberação ao desabilitar a Conta Escrow

Quando a Conta Escrow é desabilitada para uma subconta, todas as garantias ainda existentes são encerradas automaticamente e os respectivos valores passam a ficar disponíveis no saldo.

Esse comportamento ocorre independentemente do tempo restante para expiração da garantia.


Exemplo de fluxo

Um fluxo típico de liberação ocorre da seguinte forma:

Cobrança recebida
↓
Valor permanece sob garantia
↓
Recuperar garantia da cobrança
↓
Obter o id da garantia
↓
POST /v3/escrow/{id}/finish
↓
Garantia encerrada
↓
Valor disponível no saldo

Impacto operacional

Após a liberação da garantia:

  • o valor deixa de permanecer bloqueado;
  • o saldo disponível da subconta é atualizado;
  • a plataforma pode considerar o recurso como disponível para utilização, transferência ou saque.

Por esse motivo, recomenda-se que a integração acompanhe corretamente o status das garantias antes de considerar um valor disponível na conciliação financeira.


Boas práticas

Ao implementar a liberação manual de garantias, recomenda-se:

  • recuperar sempre o identificador mais recente da garantia antes de solicitar seu encerramento;
  • utilizar a liberação manual apenas quando realmente for necessário antecipar a disponibilização do saldo;
  • evitar executar múltiplas solicitações de encerramento para a mesma garantia;
  • considerar que, após a liberação, o período definido em expirationDate deixa de produzir efeito para aquela garantia.

Caso a estratégia da plataforma seja aguardar o período de retenção normalmente, não é necessário realizar nenhuma chamada de API, pois a liberação ocorrerá automaticamente.