Pular para o conteúdo
xFlow Payments

Para quem

xFlow para plataformas de infoproduto

Para plataformas de infoproduto, a xFlow é a API Pix que divide cada venda entre produtor, coprodutor e afiliado no momento do pagamento, por porcentagem do líquido ou valor fixo, e gera as cobranças por 11 adquirentes, com roteamento por regras e retentativa automática para o lançamento não parar.

Atualizado em · Equipe xFlow Payments · 5 min de leitura

Uma plataforma de infoproduto vende em nome de milhares de produtores e precisa dividir cada venda entre produtor, coprodutor, afiliado e a própria plataforma. Na xFlow Payments, essa divisão vai na cobrança Pix: você envia o split de pagamento ao criar a cobrança e, quando o pagamento é confirmado, cada parte é creditada no saldo da conta de quem recebe. Por trás da mesma chamada, a cobrança é gerada numa das 11 adquirentes da xFlow, com roteamento por regras e retentativa automática.

O que a plataforma exige do Pix

  • Comissões diferentes por venda. Cada produto tem a sua regra de coprodução, e cada venda pode ter ou não um afiliado.
  • Repasse sem planilha. Milhares de produtores esperando o dinheiro não combinam com transferência manual.
  • Pico de lançamento. Um lançamento concentra vendas em poucas horas, e um provedor instável vira carrinho perdido.
  • Clique duplo e reenvio. O comprador ansioso clica duas vezes; a rede cai no meio da chamada.
  • Contestação e reserva. Uma venda contestada precisa chegar ao time certo, com os dados do pagamento à mão.

Recursos da xFlow para cada exigência

Exigência Recurso da xFlow
Comissão por venda splits em cada POST /api/v1/charges, por PERCENTAGE (do líquido) ou FIXED (centavos)
Repasse automático Cada recebedor é creditado no próprio saldo quando o pagamento confirma
Saque de cada produtor O recebedor saca o próprio saldo por Pix, pelo painel ou com a chave de API dele
Pico de lançamento 11 adquirentes, roteamento por regras e retentativa automática
Clique duplo Idempotency-Key por pedido devolve a mesma cobrança no retry
Pedido no seu sistema external_reference volta em toda resposta e em todo webhook da cobrança
Contestação Pix Webhooks dispute.opened, dispute.accepted e dispute.rejected, quando a conta tem MED ativo

Split entre produtor, coprodutor e afiliado

A cobrança é criada pela conta da plataforma. Cada participante da venda é um item do splits:

json
"splits": [
  { "recipient_id": "id-do-produtor", "type": "PERCENTAGE", "percent": 56 },
  { "recipient_id": "id-do-coprodutor", "type": "PERCENTAGE", "percent": 14 },
  { "recipient_id": "id-do-afiliado", "type": "PERCENTAGE", "percent": 20 }
]

Nesse exemplo, o afiliado fica com 20% do líquido, o produtor com 56%, o coprodutor com 14% e a plataforma com os 10% que sobram. Repare na conta do coprodutor: se o contrato diz "20% da parte do produtor" e o produtor tem 70% do líquido, o coprodutor recebe 14% do líquido e o produtor fica com 56%. O percent é sempre sobre o líquido da cobrança, depois da taxa, então converta as regras de comissão antes de enviar. Se uma comissão for valor fixo, use "type": "FIXED" com amount em centavos.

As regras que a sua plataforma precisa respeitar:

  • Cada recebedor é uma conta da xFlow ativa e diferente da conta da plataforma. O recipient_id é o id da empresa recebedora, que ela encontra em GET /api/v1/company.
  • A soma dos percentuais não passa de 100.
  • Split inválido retorna 400, e a cobrança não é criada. Valide antes de chamar.
  • No ambiente de teste, cobranças com splits retornam 400. Teste o resto no sandbox e o split em produção.

Como milhares de produtores entram na xFlow, quem é titular de cada conta e como a plataforma recebe cada recipient_id é um desenho combinado com a equipe antes de começar. O passo a passo técnico do split, com os cuidados antes de ir para produção, está em split de pagamento para marketplace.

Repasse: o saldo de cada um

Quando o pagamento é confirmado, a parte de cada recebedor entra no saldo dele. Não há transferência da plataforma para o produtor: o crédito acontece na própria cobrança. Cada produtor, coprodutor ou afiliado saca o saldo por Pix, no painel em Recebimentos > Solicitar saque ou pela API, com a chave dele. A parte da plataforma fica no saldo da plataforma. Pela documentação, a reserva da conta, quando existe, incide só sobre o que sobra para quem criou a cobrança.

Se a plataforma também paga pessoas que não têm conta na xFlow, como afiliados que só informaram uma chave Pix, o caminho é o saque por API. O desenho está em xFlow para plataformas de payout.

Lançamento: volume sem perder venda

  • Contingência entre adquirentes. Se a adquirente escolhida pela regra não responder, a cobrança é gerada na próxima da cadeia. O comprador vê um único QR Code. Se nenhuma gerar, a resposta é 502 charge_failed: mostre um botão de tentar de novo e repita com a mesma Idempotency-Key.
  • Regras por valor, horário e dia. Uma regra pode mandar o horário do lançamento para uma adquirente e o resto do dia para outra.
  • Limite de requisições por conta. Toda resposta autenticada traz x-ratelimit-remaining e x-ratelimit-reset. No 429, espere o retry-after.
  • Webhook idempotente. O transaction.paid pode chegar mais de uma vez, porque a entrega é reenviada até 3 vezes sem resposta 2xx. Libere o acesso ao curso uma vez só, pelo id da cobrança. Os detalhes estão em webhook Pix.
  • Varredura de segurança. Depois do pico, liste GET /api/v1/charges?status=paid no período e confira se todo pedido pago teve o acesso liberado.

Contestação, estorno e reserva

Quando a conta tem MED ativo, a xFlow envia dispute.opened ao abrir uma contestação e dispute.accepted ou dispute.rejected no desfecho. A defesa é respondida no painel, em Disputas, dentro do prazo. Pela documentação, contas em plano sem MED não precisam agir, porque a equipe da xFlow cuida. O que a integração deve preparar está em MED na integração Pix.

O estorno pela API devolve o valor total da cobrança, uma vez por cobrança, até 90 dias depois do pagamento, com POST /api/v1/charges/{id}/refund. Se o saldo não cobrir, a resposta é 422 insufficient_balance. A documentação não detalha como o estorno de uma cobrança com split afeta o saldo de cada recebedor, então combine essa regra com a equipe antes de operar. As regras gerais estão em estorno Pix por API.

O que a API não faz hoje

A API trabalha com Pix: cobrança, split, estorno total e saque. Cartão, checkout hospedado e assinaturas ainda não estão na API, então a tela de pagamento e a cobrança recorrente ficam com a sua plataforma. Para a tela de pagamento, veja xFlow para plataformas de checkout.

Como começar

Crie uma chave de teste e integre a cobrança no sandbox, mesmo antes da aprovação do cadastro. Em paralelo, fale com a equipe para desenhar a entrada dos produtores e as regras de split. A referência dos campos está na documentação da API.

Perguntas frequentes

Como dividir uma venda entre produtor, coprodutor e afiliado pela API?

Enviando o campo splits ao criar a cobrança Pix, com um item por recebedor: o recipient_id da conta de cada um e a parte dele, por porcentagem do líquido (PERCENTAGE) ou por valor fixo em centavos (FIXED). O que sobra fica com a conta da plataforma.

Produtor, coprodutor e afiliado precisam ter conta na xFlow?

Sim. O recebedor do split precisa ser uma conta da xFlow ativa e diferente da conta que cria a cobrança. O recipient_id é o id da empresa recebedora, que ela encontra em GET /api/v1/company.

A porcentagem do split é calculada sobre o valor da venda?

Não. No tipo PERCENTAGE, a porcentagem incide sobre o valor líquido da cobrança, depois da taxa. Se a comissão do coprodutor é definida sobre a parte do produtor, converta para uma porcentagem do líquido antes de enviar.

O que acontece se um provedor cair no meio de um lançamento?

Se a adquirente escolhida não responder, a xFlow tenta de novo e, se precisar, gera a cobrança na próxima adquirente da cadeia. O comprador recebe um único QR Code. Se nenhuma gerar, a API responde 502 charge_failed.

Continue lendo

SoluçãoSplit de pagamentoSplit de pagamento é dividir o valor de uma venda entre mais de um recebedor. Na xFlow, você divide cada cobrança Pix entre contas da xFlow, por porcentagem ou valor fixo, direto na cobrança pela API ou como regra padrão da conta.BlogSplit de pagamento para marketplace: como montar no PixNum marketplace, o split de pagamento separa a parte de cada vendedor e a comissão da plataforma na própria cobrança. Na xFlow, você envia o campo splits ao criar a cobrança Pix, por porcentagem do líquido ou valor fixo, e cada vendedor é creditado no próprio saldo quando o pagamento é confirmado.SoluçãoRetentativa automáticaNa xFlow, a retentativa automática acontece na geração da cobrança Pix: se a adquirente escolhida não responde, a xFlow tenta de novo e, se precisar, gera a cobrança na próxima adquirente da cadeia. É o fallback de adquirente, sem mudar nada na sua integração.BlogMED na integração PixNa API da xFlow, o MED aparece em três webhooks: dispute.opened, quando uma infração é aberta, e dispute.accepted ou dispute.rejected, no desfecho da defesa. Eles chegam quando a conta tem MED ativo, e a defesa é feita no painel, em Disputas. A documentação não detalha o data desses eventos nem traz endpoint de disputas, então a integração usa o webhook como alerta e prepara evidências, saldo e conciliação.Para quemxFlow para plataformas de checkoutPara plataformas de checkout, a xFlow é a API Pix por trás da tela de pagamento: cada cobrança volta com QR Code em PNG e copia e cola, a confirmação chega por webhook assinado e a geração passa por 11 adquirentes, com roteamento por regras e retentativa automática.