Liberação dos Valores em garantia

A garantia pode ser encerrada automaticamente, manualmente pela API ou ao desabilitar a Conta Escrow da subconta.

Use a liberação manual quando sua plataforma precisar disponibilizar o valor antes de expirationDate, após validar que as condições da operação foram cumpridas.

Formas de liberação

Se a operação deve aguardar o período configurado, não execute a liberação manual.

Antes de liberar manualmente

Verifique se:

• a garantia ainda está ativa;
• a condição que autoriza a liberação foi cumprida;
• você possui o ID da garantia da Conta Escrow.

Como liberar uma garantia

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Localizar a cobrança"] --> B["Recuperar a garantia"]
    B --> C["Obter o ID da garantia"]
    C --> D["Validar a condição de liberação"]
    D --> E["Encerrar a garantia"]
    E --> F["Disponibilizar o valor no saldo"]

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
    classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

    class A inicio
    class B,C,D,E validacao
    class F sucesso

    linkStyle default stroke:#94A3B8,stroke-width:2px

1. Recupere o ID da garantia

Se sua aplicação ainda não possui o identificador da garantia, recupere-o a partir da cobrança:

GET /v3/payments/{id}/escrow

Nesse endpoint, {id} corresponde ao ID da cobrança.

Consulte o endpoint Recuperar garantia da cobrança na Conta Escrow.

Armazene o id retornado para utilizar no encerramento da garantia.

2. Encerre a garantia

Após validar que o valor pode ser liberado, envie:

POST /v3/escrow/{id}/finish

Nesse endpoint, {id} corresponde ao ID da garantia da Conta Escrow, e não ao ID da cobrança.

Exemplo:

POST /v3/escrow/esc_123456/finish

Consulte o endpoint Encerrar garantia da cobrança na Conta Escrow.

Resultado esperado

Uma resposta 200 OK confirma o encerramento da garantia.

Após o encerramento:

• a garantia deixa de permanecer ativa;
• o valor deixa de ficar retido;
• o recurso passa a compor o saldo disponível da subconta.

O encerramento é definitivo para aquela garantia. Não existe mecanismo para reativá-la após a conclusão.

Erros comuns

Se a garantia não puder ser encerrada, verifique se:

• o ID informado pertence à garantia, e não à cobrança;
• a garantia existe para a conta autenticada;
• a garantia ainda está ativa;
• a mesma garantia não foi encerrada anteriormente.

Não envie múltiplas solicitações de encerramento para a mesma garantia.

Liberação ao desabilitar a Conta Escrow

Desabilitar a Conta Escrow possui um efeito diferente da liberação manual de uma única garantia: todas as garantias existentes da subconta são encerradas.

Use esse fluxo somente quando a subconta não deve mais manter novos recebimentos sob garantia.

Consulte como desabilitar a Conta Escrow.

Próximos passos

• Consulte valores sob garantia da Conta Escrow
• Consulte o endpoint Recuperar garantia da cobrança na Conta Escrow
• Consulte o endpoint Encerrar garantia da cobrança na Conta Escrow
• Desabilite a Conta Escrow