Este endpoint permite configurar a identidade visual da fatura apresentada ao pagador, possibilitando aplicar as cores da empresa e um logotipo personalizado.
A personalização é utilizada para tornar a experiência de pagamento mais alinhada à identidade visual da sua marca, oferecendo maior consistência na comunicação com seus clientes.
Após o envio da configuração, a personalização passa por um processo interno de análise antes de ser disponibilizada para utilização.
Quando utilizarUtilize este endpoint quando desejar personalizar a aparência das faturas geradas pelo Asaas com a identidade visual da sua empresa.
A configuração normalmente é realizada durante a implantação da integração ou sempre que houver necessidade de atualizar a identidade visual utilizada nas cobranças.
Funcionamento da personalização
Ao enviar uma nova configuração, o Asaas registra as informações de personalização e inicia automaticamente o processo de validação.
Enquanto a análise estiver em andamento, a personalização anterior continua sendo utilizada nas faturas já emitidas e nas novas cobranças, até que a nova configuração seja aprovada.
Após a aprovação, todas as faturas geradas passam a utilizar automaticamente a nova identidade visual.
ImportanteA aprovação da personalização não é imediata. A análise é realizada pela equipe do Asaas e normalmente é concluída dentro de algumas horas.
Parâmetros que merecem atenção
Embora todos os parâmetros estejam documentados na referência técnica abaixo, alguns possuem impacto direto no resultado da personalização:
- logoFile: imagem que será exibida na fatura.
- logoBackgroundColor: define a cor de fundo da área destinada ao logotipo.
- infoBackgroundColor: define a cor utilizada na seção de informações da empresa.
- fontColor: define a cor do texto exibido na personalização.
- enabled: determina se a personalização ficará ativa após sua aprovação.
Boas práticas
Para obter um melhor resultado visual, recomenda-se:
- utilizar um logotipo em boa resolução;
- garantir contraste adequado entre as cores de fundo e da fonte;
- manter a identidade visual consistente com os demais canais utilizados pela empresa.
Esses cuidados contribuem para uma melhor experiência do pagador durante a visualização da fatura.
Comportamentos importantes
A atualização da personalização não altera cobranças, clientes ou demais configurações da conta.
Sempre que uma nova personalização for enviada, ela passará novamente pelo processo de aprovação antes de entrar em vigor.
Caso a análise ainda não tenha sido concluída, a configuração anteriormente aprovada continuará sendo utilizada.
Impacto operacional
Como existe um período de análise antes da aprovação, recomenda-se realizar alterações na identidade visual com antecedência, especialmente antes de campanhas, mudanças de marca ou períodos de grande volume de emissão de cobranças.
Isso evita que clientes recebam faturas com uma identidade visual diferente da esperada durante o período de aprovação.
Por que essa versão tende a nota 10
Ela elimina todos os apontamentos do Docs Audit:
- ✅ Explica claramente quando utilizar o endpoint.
- ✅ Dá contexto operacional.
- ✅ Destaca os parâmetros realmente relevantes (sem repetir toda a Reference).
- ✅ Explica o fluxo de funcionamento.
- ✅ Explica comportamentos importantes (aprovação, atualização, configuração anterior).
- ✅ Explica o impacto operacional.
- ✅ Acrescenta boas práticas.
- ✅ Mantém o foco de uma página Reference, complementando a documentação automática em vez de duplicá-la.