Skip to main content
Esta página só se aplica a contas com o produto Chargefy for Platforms habilitado. Nesse produto, uma plataforma opera pagamentos para suas organizações filhas.
Sua plataforma tem uma marca própria — cores, fonte, tema, cantos, logo principal, marca do rodapé com o endereço para onde ela leva e domínio próprio —, configurada em Configurações da plataforma → Marca. Cada organização filha também tem a sua, em Configurações → Marca da própria organização. Esta página explica qual das duas veste cada página hospedada e como mudar isso. Tudo é configurado no Dashboard. Não existe campo novo na API: os objetos públicos, os headers e os webhooks continuam iguais, e as URLs devolvidas pela API já refletem a marca e o domínio em uso.

Duas marcas, um vendedor

Marca e domínio não mudam quem vende. A organização filha continua identificada como vendedora — nome, CPF/CNPJ e descritor no extrato do comprador —, e taxas, repasses, permissões, header Organization e webhooks seguem exatamente iguais. A escolha é só de apresentação.

Escolha quem apresenta as vendas da plataforma

Em Configurações da plataforma → Marca, defina o padrão para as vendas que a plataforma cria por API para suas organizações filhas — Checkout Sessions, Payment Links, as assinaturas e faturas que nascem delas e as sessões do portal do cliente:

Exceção por organização filha

No painel da plataforma, na organização filha, você pode sobrescrever o padrão só para ela: uma plataforma que apresenta tudo com a própria marca pode deixar uma organização usar a marca dela, e uma plataforma que deixa cada organização com a própria marca pode apresentar uma delas com a marca da plataforma. Sem exceção, a organização segue o padrão da plataforma.

Quando a escolha é aplicada

A origem da marca é gravada em cada venda no momento em que ela nasce, e recursos derivados herdam da origem: a sessão aberta a partir de um Payment Link usa a marca do link, a assinatura usa a marca da sessão que a criou e cada fatura usa a marca da assinatura.
  • Mudar o padrão ou uma exceção vale para as vendas novas. Recursos que já existem mantêm a marca com que nasceram. Um Payment Link criado antes da mudança continua apresentando a marca antiga em todas as sessões que gerar; crie outro link para usar a nova.
  • Mudar a marca em si vale para tudo. Alterar cores, fonte, tema, cantos, logos ou domínio de uma marca aparece em todas as páginas que usam essa marca, inclusive links e faturas já enviados.

Ativação e revisão cadastral

As páginas de ativação (activation_session) e de revisão cadastral das organizações filhas usam sempre a marca da plataforma que as apresenta, independentemente da escolha acima. Por padrão elas abrem em hosted.chargefy.io; com o domínio da plataforma pronto e ativo, a url da sessão de ativação já vem no seu endereço.

Domínio próprio da plataforma

O domínio da plataforma é cadastrado em Configurações da plataforma → Marca, com os mesmos registros DNS, estados e regras de recuperação descritos em Usar seu próprio domínio. Cada marca aceita um domínio, e o mesmo hostname não pode pertencer à plataforma e a uma organização ao mesmo tempo. Cada hostname só serve as páginas da própria marca. Um link de uma venda apresentada com a marca da organização filha não abre no domínio da plataforma, e um link apresentado com a marca da plataforma não abre no domínio da organização: a página responde “não encontrada”, sem expor nenhum dado do comprador. Os endereços padrão da Chargefy continuam abrindo qualquer link.

Configurar

1

Ajuste a marca da plataforma

Em Configurações da plataforma → Marca, defina cores, fonte, tema, cantos, logo principal, marca do rodapé e o endereço para onde ela leva. As mesmas escolhas da marca de uma organização, descritas em Configurar sua página de checkout.
2

Cadastre o domínio da plataforma

Opcional. Informe um subdomínio seu e crie os registros DNS conforme o guia Usar seu próprio domínio. Até o domínio ficar pronto, as páginas usam os endereços padrão.
3

Escolha o padrão das vendas

Selecione Marca e domínio da organização ou Marca e domínio da plataforma. A escolha vale para as vendas criadas dali em diante.
4

Abra exceções, se precisar

Na organização filha que deve fugir do padrão, escolha a origem da marca só para ela.
5

Teste com uma venda nova

Crie uma Checkout Session com a API key da plataforma e o header Organization da organização filha. A url retornada mostra o domínio em uso; abra-a e confira a marca aplicada.

Na API

Nenhum endpoint ganha campo por causa desta configuração. O que a API mostra:
  • branding_settings no objeto Organization continua descrevendo a marca da organização filha — cores, fonte, tema e cantos, sempre preenchidos —, mesmo quando a plataforma apresenta as vendas dela com a marca da plataforma. Logo, rodapé, domínio e a origem da marca são configurados no Dashboard e não aparecem nos objetos públicos.
  • As URLs hospedadas — url da Checkout Session, do Payment Link e da sessão do portal, hosted_invoice_url da fatura e url da sessão de ativação — já vêm com o domínio em uso para aquele recurso.
  • O campo top-level organization dos webhooks e o header Organization continuam apontando para a organização filha vendedora.

Próximos passos

Usar seu próprio domínio

Registros DNS, estados, falhas e o que acontece com links já enviados.

Configurar sua página de checkout

A marca e o Checkout Builder de uma organização.

Ativar organização por sessão hospedada

A página de ativação usa a marca e o domínio da plataforma.

Operar organizações conectadas

Criação, header Organization e webhooks das organizações filhas.