Valores sob garantia da Conta Escrow

Quando uma subconta possui a Conta Escrow habilitada, todas as novas cobranças e parcelamentos recebidos passam a ficar temporariamente sob garantia durante o período configurado para essa subconta.

Enquanto permanecerem sob garantia, esses valores não ficam disponíveis no saldo da subconta e aguardam a liberação automática ou manual, conforme o fluxo da Conta Escrow.

O período de retenção é definido pelo atributo daysToExpire, configurado na etapa de Configuração da Conta Escrow para as subcontas.

Como consultar valores sob garantia

É possível consultar o status de uma garantia autenticando a requisição com a API Key da própria subconta e utilizando o endpoint Recuperar garantia da cobrança na Conta Escrow.

Confira a referência completa deste endpoint

Além da consulta individual, as informações da garantia também são disponibilizadas no objeto escrow retornado pelos endpoints de consulta e listagem de cobranças.

Isso permite que a integração acompanhe o status da retenção sem necessidade de manter controles paralelos.

Informações disponíveis

Ao consultar uma garantia, é possível acompanhar informações como:

• situação atual da garantia;
• data prevista para encerramento (expirationDate);
• dados da cobrança relacionada;
• informações utilizadas pelo fluxo de retenção da Conta Escrow.

Esses dados permitem que a plataforma acompanhe quando um valor ainda permanece bloqueado e quando poderá ser disponibilizado para a subconta.

Exemplo de fluxo

Em um fluxo típico, o comportamento ocorre da seguinte forma:

Conta Escrow habilitada
↓
Cobrança recebida
↓
Valor permanece sob garantia
↓
Consulta do status pela API
↓
Liberação automática ou manual
↓
Valor disponível no saldo da subconta

Impacto operacional

Durante o período em que o valor permanece sob garantia:

• o recebimento já existe e pode ser consultado normalmente pela API;
• o valor ainda não está disponível para utilização pela subconta;
• a conciliação financeira deve considerar que o recebimento ocorreu, mas permanece bloqueado até o encerramento da garantia.

Esse comportamento é importante para integrações que realizam controle de saldo, repasses ou conciliações financeiras.

Comportamento da garantia

Os valores permanecem sob garantia até que ocorra uma das situações previstas para encerramento da retenção.

A liberação pode ocorrer:

• automaticamente, quando o período definido em daysToExpire expira;
• manualmente, utilizando o endpoint específico de liberação da garantia;
• ao desabilitar a Conta Escrow para a subconta, quando todas as garantias existentes são encerradas.

Os procedimentos de liberação são detalhados na página Liberação dos valores em garantia.

Boas práticas

Ao implementar o acompanhamento de garantias, recomenda-se:

• utilizar sempre a API Key da subconta para consultar informações da garantia;
• consultar o objeto escrow retornado pelas cobranças para identificar rapidamente se existe retenção de valores;
• considerar o período de garantia na conciliação financeira da plataforma;
• evitar assumir que um pagamento recebido já está disponível para utilização antes de verificar o status da garantia.

Esses cuidados ajudam a manter o controle correto dos valores disponíveis e dos valores ainda retidos pela Conta Escrow.