Pular para o conteúdo principal
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 — aparência (cores, estilo, fontes e tema claro ou escuro), logo principal, marca do rodapé e domínio próprio —, configurada em Configurações da plataforma → Plataforma → Branding. Cada organização filha pode ter a sua, em Configurações → Branding da própria organização; a aparência dela também pode ser definida pela API. Esta página explica qual das duas veste cada página hospedada e como mudar isso. A marca da plataforma, o domínio e a escolha de quem apresenta a venda são configurados no Dashboard. As URLs devolvidas pela API já refletem o domínio em uso.

Criar páginas white-label com um assistente MCP

Escolha a experiência antes de pedir a implementação ao assistente: O MCP pesquisa os guias, detalha os contratos disponíveis e ajuda a revisar a integração. A conexão na organização dona da plataforma pode consultar suas organizações filhas, mas não cria pagamentos nelas. Criar Checkout Sessions e setup intents, cobrar e configurar marca ou domínio não são operações disponíveis no MCP. Um Payment Link criado pelo MCP pertence à organização autorizada na conexão e usa a marca dessa organização. Para criar uma venda para uma filha e aplicar a escolha de marca da plataforma, seu backend deve usar a API key da plataforma e o header Organization da filha. A chave de plataforma não autentica o MCP; o argumento organization do MCP apenas seleciona um escopo já autorizado e não substitui esse header. Exemplo de pedido para uma página hospedada:
Uso Chargefy for Platforms e quero páginas hospedadas com a marca e o domínio da plataforma para minhas organizações filhas. Leia este guia e o de criação de Checkout Sessions. Confira os escopos e operações do MCP, indique as configurações necessárias no Dashboard e implemente no meu backend a criação por API com a chave de plataforma, o header Organization e idempotência. Use a URL retornada e confirme o pagamento por webhook. Comece em sandbox.

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.

Aparência herdada pelas organizações filhas

Uma organização filha sem aparência própria veste a aparência da plataforma, inclusive nas vendas que ela mesma cria. Se a plataforma também não tiver uma, vale a aparência padrão da Chargefy. Por exemplo: sua plataforma usa o botão verde #278629. A Acme Ltda, uma organização filha que nunca escolheu aparência, vende com checkout de botão verde, logo e nome da Acme. Se a Acme salvar o botão indigo, o checkout dela passa a ser índigo, e uma troca de cor na plataforma deixa de chegar até ela. Para voltar a seguir a plataforma, apague a aparência própria dela (appearance: null). A herança vale só para a aparência. A logo das páginas continua sendo a da organização filha — o avatar_url dela, ou a logo escolhida no Dashboard —, e a marca do rodapé, a da própria organização. O guia Marca e aparência descreve as seis escolhas da aparência.

Escolha quem apresenta as vendas da plataforma

Em Configurações da plataforma → Pagamentos → Checkout, na seção Identidade no cabeçalho, 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 a aparência, as logos ou o domínio de uma marca aparece em todas as páginas que usam essa marca, inclusive links e faturas já enviados. A aparência da plataforma também chega às organizações filhas que não têm aparência própria.

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. Quando a plataforma tem um endereço gratuito, a url já usa esse endereço, como imoveis.chargefy.io. Com um domínio próprio pronto e ativo, a URL passa a usar o domínio próprio. Plataformas que ainda não escolheram um endereço usam hosted.chargefy.io.

Endereço da plataforma

Na configuração inicial, escolha um endereço gratuito, como imoveis.chargefy.io. O Dashboard sugere o nome e confere a disponibilidade. Não há contratação nem configuração de DNS nessa etapa. Depois de concluir, o endereço fica reservado e não pode ser alterado, para preservar os links enviados. Plataformas que ainda não escolheram um endereço podem defini-lo em Configurações da plataforma → Domínios. O endereço serve as páginas que usam a marca da plataforma. Se você contratar um domínio próprio depois, os links no endereço gratuito continuam funcionando.

Domínio próprio da plataforma

O domínio próprio é opcional e contratado depois, em Configurações da plataforma → Domínios, 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 → Plataforma → Branding, defina a aparência (cores, estilo, fontes e tema); a marca do rodapé fica em Configurações da plataforma → Pagamentos → Checkout. São as mesmas escolhas da marca de uma organização, descritas em Marca e aparência.
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 o endereço gratuito escolhido pela plataforma, ou os endereços padrão quando ela ainda não escolheu um.
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

O que a API mostra:
  • branding_settings.appearance no objeto Organization traz só a aparência que a organização filha salvou, ou null quando ela segue a da plataforma. A aparência herdada não aparece, e o campo continua descrevendo a organização filha mesmo quando a plataforma apresenta as vendas dela com a marca da plataforma.
  • Para definir ou apagar a aparência de uma organização filha, envie branding_settings.appearance em POST /v1/organizations/{id}, com a API key da plataforma. Cada mudança gera organization.updated.
  • A logo das páginas é o avatar_url da organização, a menos que outra logo tenha sido escolhida no Dashboard. Marca do rodapé, domínio e a origem da marca são configurados só 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.

Marca e aparência

As seis escolhas da aparência e como definir a de uma organização filha pela API.

Configurar sua página de checkout

Logo, marca do rodapé 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.