Configurando a Conta Escrow para as subcontas

Configure a Conta Escrow individualmente para uma subconta ou defina uma configuração padrão para toda a estrutura de subcontas.

Após a habilitação, novas cobranças e parcelamentos recebidos pelas subcontas configuradas passam a seguir o fluxo de retenção pelo período definido em daysToExpire.

Escolha o tipo de configuração

Necessidade	Configuração
Habilitar ou definir regras diferentes para uma subconta específica	Configuração individual
Aplicar a mesma configuração às subcontas existentes e às criadas futuramente	Configuração padrão

A configuração padrão continua sendo aplicada às novas subcontas até que seja alterada novamente.

Antes de começar

Verifique se:

a Conta Escrow está disponível para sua conta;
a subconta já existe, caso utilize a configuração individual;
você possui o id da subconta que será configurada individualmente;
o período de retenção e o responsável pela taxa estão definidos para o cenário.

1. Configure uma subconta específica

Utilize este fluxo quando uma subconta precisar de uma configuração própria.

POST /v3/accounts/{id}/escrow

Exemplo:

{
  "enabled": true,
  "isFeePayer": true,
  "daysToExpire": 10
}

Os campos utilizados definem:

enabled: habilita ou desabilita a Conta Escrow;
isFeePayer: define se a própria subconta será responsável pela taxa da Conta Escrow. Se não informado ou definido como false, a cobrança será realizada na conta principal;
daysToExpire: define a quantidade de dias até a expiração da garantia e a liberação automática do valor.

Consulte o endpoint Salvar ou atualizar configuração da Conta Escrow para a subconta.

🚧
Atenção
Ao criar ou atualizar a configuração com o status habilitado para uma subconta, apenas as cobranças e parcelamentos recebidos após essa configuração serão submetidos ao fluxo de bloqueio sob garantia da Conta Escrow.
Recebimentos anteriores permanecem inalterados.
Confira também a seção de Bloqueio dos valores.

📘
Importante
O período informado em daysToExpire será aplicado aos novos recebimentos processados após a configuração da Conta Escrow.

Como validar

A requisição deve retornar 200 OK.

Se precisar confirmar a configuração registrada para a subconta, utilize:

GET /v3/accounts/{id}/escrow

Consulte o endpoint Recuperar configuração da Conta Escrow para a subconta.

2. Defina uma configuração padrão

Utilize a configuração padrão quando todas as subcontas devem seguir as mesmas regras da Conta Escrow.

POST /v3/accounts/escrow

Exemplo:

{
  "enabled": true,
  "isFeePayer": true,
  "daysToExpire": 10
}

A configuração será aplicada:

às subcontas existentes;
às subcontas criadas futuramente.

Novas subcontas continuarão herdando essa configuração até que ela seja alterada.

Consulte o endpoint Criar configuração padrão da Conta Escrow para todas as subcontas.

Como validar

A requisição deve retornar 200 OK.

A aplicação da configuração às subcontas existentes pode levar alguns instantes, conforme a quantidade de subcontas vinculadas à conta principal.

Para consultar a configuração padrão registrada, utilize:

GET /v3/accounts/escrow

Consulte o endpoint Recuperar configuração padrão da Conta Escrow.

❗️
Importante
Ao habilitar a Conta Escrow para uma subconta, a cobrança da mensalidade será realizada no dia seguinte à ativação.
As cobranças seguintes ocorrerão mensalmente enquanto a funcionalidade permanecer habilitada.
Consulte também a seção Cobrança da taxa por subconta configurada.

Próximos passos

Updated 13 days ago

Did this page help you?