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.
Um plano reúne as taxas por venda e uma tabela de juros de parcelamento. Cada organização filha recebe uma combinação completa. Vários planos podem usar a mesma tabela de juros. Crie os planos em Configurações da plataforma → Planos e taxas. Escolha as taxas e uma tabela liberada para a plataforma. O sistema confere a combinação antes de salvar, considerando os custos de cada condição de pagamento e os arredondamentos.

Condições fixas

Depois de criado, o plano permite editar nome e descrição. Taxas e tabela de juros ficam fixas. Uma combinação diferente exige outro plano. Planos especiais de repasse integral, concedidos à plataforma, acompanham a condição contratada e deixam os juros com a organização. A plataforma não retém receita nessas cobranças. Se o comprador pagar R110comjuroseataxadacobranc\caforR 110 com juros e a taxa da cobrança for R 10, a organização recebe R$ 100. Cobranças anteriores mantêm as condições registradas. Por exemplo: uma organização paga 3,99% por venda e usa a tabela de juros de 2,99%. Para oferecer 4,29% com juros de 1,99%, crie outro plano e atribua-o à organização. A próxima cobrança usa a combinação escolhida; cobranças já criadas mantêm os valores anteriores.

Plano padrão

O padrão vale para organizações criadas sem escolha explícita de plano. Trocar o padrão não muda organizações existentes. A etapa Defina sua taxa cria a combinação escolhida com o nome Padrão Plataforma {nome da plataforma}, que você pode renomear depois, e a define como padrão. A organização dona da plataforma passa a usar esse plano e as organizações conectadas permanecem nos planos atribuídos. O Padrão criado pela Chargefy sai da lista quando nenhuma organização conectada estiver nele. Antes de haver condições liberadas, a plataforma pode estar sem planos; ao receber o primeiro plano, as organizações sem combinação recebem esse plano.

Escolher o plano de uma organização

No detalhe da organização filha, abra Taxas e selecione o plano. A tabela de juros acompanha a escolha e não tem edição separada. Pela API de produção, envie fee_plan ao criar ou atualizar: Com chave de teste, omita fee_plan. Enviá-lo retorna 400 livemode_mismatch. installment_plan é somente leitura: os juros são definidos pelo plano. Escolher um plano:
Escolher o padrão atual:

Consultar pela API

Use a API key da plataforma, sem o header Organization. Para descobrir o plano padrão atual:
Para saber quanto uma organização paga, leia organization.fee_plan e consulte esse plano em GET /v1/fee-plans/{id}. As condições ficam em rates, com fee_rate em pontos-base (399 = 3,99%) e fixed_fee_amount em centavos. O formato completo está no objeto fee_plan.

Eventos

Os eventos fee.plan.* chegam aos endpoints com events_from: "platform", um por modo (teste e produção). Neles, o campo top-level organization é a organização da sua plataforma.

Próximos passos

Objeto fee_plan

Consulte todos os campos do plano e das condições.

Operar organizações conectadas

Crie organizações filhas e escolha o plano de cada uma.

Tabelas de juros

As tabelas liberadas aparecem na criação do plano. Os juros de cada quantidade de parcelas vêm da tabela escolhida. Quem paga os juros continua sendo uma escolha da cobrança (interest_payer).