Acompanhe valores sob garantia da Conta Escrow

Quando uma cobrança ou parcelamento é recebido por uma subconta com a Conta Escrow habilitada, o valor permanece sob garantia durante o período configurado em daysToExpire.

Enquanto a garantia estiver ativa, o recebimento existe, mas o valor ainda não está disponível no saldo da subconta.

Consulte a garantia de uma cobrança

Para recuperar a garantia, autentique a requisição com a API Key da própria subconta e informe o ID da cobrança:

GET /v3/payments/{id}/escrow

O parâmetro {id} corresponde ao ID da cobrança.

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

Resultado esperado

Uma resposta 200 OK permite identificar os dados atuais da garantia, incluindo:

• situação da garantia;
• expirationDate, com a data prevista para seu encerramento;
• identificador da garantia;
• informações relacionadas à cobrança.

Armazene o identificador da garantia caso sua integração precise realizar a liberação manual posteriormente.

As informações da garantia também estão disponíveis no objeto escrow retornado pelos endpoints de consulta e listagem de cobranças.

Como interpretar a retenção

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
    A["Receber a cobrança"] --> B["Manter o valor sob garantia"]
    B --> C["Consultar os dados em escrow"]
    C --> D{"Como a garantia será encerrada?"}

    D --> DAuto(("Expiração"))
    D --> DManual(("Liberação manual"))
    D --> DDisable(("Desabilitação"))

    DAuto --> E["Atingir expirationDate"]
    DManual --> F["Encerrar a garantia pela API"]
    DDisable --> G["Desabilitar a Conta Escrow"]

    E --> H["Disponibilizar o valor no saldo"]
    F --> H
    G --> H

    classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
    classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,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

    classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px
    classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px
    classDef respostaOpcao fill:#8B5CF6,stroke:#6D28D9,color:#FFFFFF,stroke-width:3px

    class A inicio
    class D decisao
    class B,C,E,F,G validacao
    class H sucesso

    class DAuto respostaSim
    class DManual respostaOpcao
    class DDisable respostaNao

    linkStyle default stroke:#94A3B8,stroke-width:2px
    linkStyle 2 stroke:#22C55E,stroke-width:4px
    linkStyle 3 stroke:#8B5CF6,stroke-width:4px
    linkStyle 4 stroke:#EF4444,stroke-width:4px

A garantia pode ser encerrada:

• automaticamente ao atingir expirationDate;
• manualmente pela plataforma;
• ao desabilitar a Conta Escrow para a subconta.

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

Considere a garantia na conciliação

Não considere um recebimento como saldo disponível apenas porque a cobrança foi recebida.

Enquanto a garantia estiver ativa:

• o recebimento pode ser consultado normalmente;
• o valor permanece bloqueado;
• transferências, saques ou outros usos do saldo devem considerar apenas os recursos efetivamente disponíveis.

Use o objeto escrow para diferenciar valores recebidos de valores já liberados.

Próximos passos

• Configure a Conta Escrow para as subcontas
• Libere valores em garantia
• Consulte o endpoint Recuperar garantia da cobrança na Conta Escrow
• Desabilite a Conta Escrow