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


Este endpoint permite definir uma configuração padrão da Conta Escrow que será aplicada automaticamente a todas as subcontas vinculadas à conta principal.

Após a configuração, todas as subcontas existentes passam a utilizar os parâmetros definidos e qualquer nova subconta criada herdará automaticamente essa mesma configuração, dispensando configurações individuais durante o processo de criação.

📘

Quando utilizar

Utilize este endpoint quando desejar padronizar a utilização da Conta Escrow em toda a estrutura de subcontas da integração.

Esse cenário é comum em plataformas que administram um grande número de subcontas e desejam manter uma configuração única para todas elas, simplificando o processo de provisionamento de novos estabelecimentos.


Pré-requisitos

Antes de utilizar este endpoint, recomenda-se verificar se:

  • a conta principal possui permissão para utilizar a Conta Escrow;
  • as subcontas que deverão receber a configuração já foram criadas, quando aplicável;
  • a configuração definida atende à política operacional da plataforma, pois ela será utilizada como padrão para novas subcontas.

Funcionamento da configuração

Ao executar esta operação, o Asaas inicia o processo de atualização da configuração padrão da Conta Escrow.

A configuração será aplicada:

  • às subcontas já existentes;
  • às subcontas criadas futuramente.

Novas subcontas herdarão automaticamente essa configuração até que ela seja alterada novamente pela conta principal.

🚧

Importante

A configuração padrão afeta somente a herança de configurações das subcontas. Caso existam comportamentos específicos previstos para determinadas operações, eles deverão ser avaliados conforme a estratégia da sua integração.


Parâmetros que merecem atenção

Embora todos os parâmetros estejam documentados na referência técnica abaixo, alguns possuem impacto direto no comportamento da Conta Escrow:

  • enabled: habilita ou desabilita a utilização da Conta Escrow para as subcontas.
  • daysToExpire: define o período de retenção dos valores em garantia antes da liberação.
  • isFeePayer: determina quem será responsável pelo pagamento da taxa da Conta Escrow quando essa informação não for definida individualmente.

Esses parâmetros passam a compor a configuração padrão utilizada pelas subcontas.


Exemplo de utilização

Um cenário comum ocorre quando uma plataforma cria novas subcontas diariamente.

Em vez de configurar a Conta Escrow individualmente para cada nova conta criada, a plataforma define uma configuração padrão utilizando este endpoint. Assim, todas as novas subcontas passam a herdar automaticamente essas definições, reduzindo a complexidade operacional da integração.


Comportamentos importantes

Após a atualização:

  • as subcontas existentes passam a utilizar a nova configuração padrão;
  • novas subcontas criadas herdarão automaticamente essa configuração;
  • alterações futuras poderão ser realizadas executando novamente este endpoint.

A atualização da configuração não exige que cada subconta seja configurada manualmente.


Boas práticas

Antes de alterar a configuração padrão, recomenda-se:

  • validar se a política de utilização da Conta Escrow será a mesma para todas as subcontas;
  • realizar a alteração em momentos de menor atividade operacional, sempre que possível;
  • confirmar internamente quem será o responsável pelo pagamento das taxas da Conta Escrow antes de definir o parâmetro isFeePayer.

Esses cuidados ajudam a evitar alterações inesperadas na operação das subcontas.


Impacto operacional

Como esta operação pode atualizar um grande número de subcontas, sua conclusão pode levar alguns instantes.

🚧

Importante

O tempo de processamento varia conforme a quantidade de subcontas existentes na conta principal. Recomenda-se aguardar a conclusão da operação antes de realizar validações ou assumir que todas as subcontas já receberam a nova configuração.


Conteúdos relacionados

Este endpoint normalmente faz parte do seguinte fluxo de configuração:

Criar subconta
        ↓
Definir configuração padrão da Conta Escrow
        ↓
Criar novas subcontas
        ↓
As novas subcontas herdam automaticamente a configuração

Caso sua integração utilize recursos relacionados, consulte também:

  • Habilitar Conta Escrow para uma subconta;
  • Consultar configuração da Conta Escrow;
  • Criar subcontas.

Body Params
int32
required

Quantidade de dias para expiração do bloqueio dos valores em garantia na Conta Escrow

boolean

Indica se a Conta Escrow está habilitada

boolean

Indica se a subconta é responsável pelo pagamento da taxa da Conta Escrow. Caso não informado, a taxa será paga pela conta principal

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json