Fluxo de Pagamento
O fluxo de pagamento é o caminho que cada transação percorre até chegar ao provedor que vai processá-la. É nele que você decide, por exemplo, que pagamentos em reais vão para um provedor e pagamentos em pesos vão para outro, ou que 70% das transações seguem por um provedor e 30% por outro.
Você monta esse caminho de forma visual: adiciona as condições que quiser, liga uma na outra e finaliza indicando o provedor que deve receber o pagamento.
Como funciona
Cada fluxo pertence a um único método de pagamento (cartão de crédito, cartão de débito, PIX, transferência ou carteiras digitais). Você pode criar quantos fluxos quiser para o mesmo método, mas apenas um fica ativo por vez — é o ativo que será usado nos pagamentos.
Quando um pagamento chega, a plataforma percorre o fluxo ativo daquele método, avalia cada condição e encaminha a transação para o provedor indicado no final do caminho.
Se não houver nenhum fluxo ativo para o método de pagamento, as transações desse método não são processadas.
Antes de começar
Para que um provedor apareça como opção ao montar o fluxo, ele precisa estar:
- contratado e ativo na sua conta;
- com as credenciais cadastradas;
- com as taxas configuradas para o país e o método de pagamento;
- disponível para o método de pagamento que você está configurando.
Se um provedor que você espera não aparecer na lista, verifique estes quatro pontos antes de qualquer outra coisa. A lista de provedores exibida na tela é montada a partir do que está habilitado na sua conta.
A tela de fluxos
Acesse Fluxo de pagamento no menu. A tela mostra abas com os métodos de pagamento disponíveis para a sua conta, e em cada aba a lista de fluxos já criados, com:
- Nome do Fluxo;
- Última modificação;
- as ações Editar, Visualizar e o botão que ativa ou desativa o fluxo.
Criando um fluxo passo a passo
1. Escolha o método de pagamento
Selecione a aba do método que você quer configurar e clique em Criar novo fluxo.
O método é definido pela aba de origem e não pode ser alterado depois. Para configurar outro método, crie um novo fluxo na aba correspondente.
2. Dê um nome ao fluxo
Preencha o campo Nome do fluxo no topo da tela. Use até 100 caracteres e prefira nomes que identifiquem a regra, como "Cartão de crédito — Brasil" ou "PIX com balanceamento".
Se você deixar o campo em branco, a plataforma gera um nome automático, como "Fluxo de pagamento 1".
3. Adicione as condições
Use os botões acima do diagrama para adicionar condições. Cada botão abre uma janela onde você escolhe os valores e, ao confirmar em Adicionar, um novo bloco aparece no diagrama.
Você pode combinar quantas condições quiser, uma após a outra.
4. Ligue os blocos
Cada condição tem duas saídas: Sim e Não. Arraste a partir de cada saída até o próximo bloco para montar o caminho.
- A saída Sim define o que acontece quando a condição é atendida;
- A saída Não define o que acontece quando ela não é atendida.
Todas as condições precisam ter as duas saídas ligadas. Se algum caminho ficar solto, o fluxo não poderá ser salvo.
5. Termine com um provedor
Todo caminho do fluxo precisa terminar em um bloco de PSP — o provedor que vai processar o pagamento. Um fluxo que tenha qualquer caminho sem provedor no final não é aceito.
6. Salve
Clique em Salvar. Se estiver tudo certo, você volta para a lista de fluxos e o novo fluxo aparece na aba do método escolhido.
Se algo estiver incompleto, uma mensagem indica o que precisa ser corrigido. Consulte a seção Mensagens que você pode encontrar.
Condições disponíveis
| Condição | O que faz | Disponível em |
|---|---|---|
| País | Direciona o pagamento conforme o país da transação | Todos os métodos |
| Moeda | Direciona o pagamento conforme a moeda | Todos os métodos |
| Bandeira | Direciona conforme a bandeira do cartão | Cartão de crédito e cartão de débito |
| Parcelas | Direciona conforme a quantidade de parcelas | Cartão de crédito |
| Valor | Direciona conforme o valor do pagamento | Todos os métodos |
| Balanceador | Divide os pagamentos entre provedores por percentual | Todos os métodos |
| PSP | Define o provedor que processa o pagamento (final do caminho) | Todos os métodos |
Sobre a condição Valor
Ao configurar a condição Valor, escolha o operador (Maior que, Maior ou
igual, Menor que, Menor ou igual, Igual ou Diferente) e informe o valor na
moeda do pagamento — por exemplo, 100 para R$ 100,00. Não é necessário
converter para centavos.
Sobre a condição Parcelas
Disponível apenas para cartão de crédito. Use-a para enviar, por exemplo, pagamentos à vista para um provedor e parcelados para outro.
Provedor principal e provedores alternativos
Você pode encadear provedores para que, se o primeiro não conseguir processar o pagamento, a plataforma tente o seguinte automaticamente.
Para isso, ligue a saída de um bloco de provedor ao próximo bloco de provedor. A ordem da ligação define a prioridade:
[ PSP A ] ──► [ PSP B ] ──► [ PSP C ]
principal alternativo alternativo
Neste exemplo, todos os pagamentos vão primeiro para o PSP A. Se ele não puder processar, a plataforma tenta o PSP B e, em seguida, o PSP C.
Dividindo pagamentos entre provedores
O Balanceador distribui as transações entre dois ou mais provedores segundo os percentuais que você definir.
- Clique em Balanceador;
- Informe o percentual de cada faixa e use Adicionar mais para criar novas faixas;
- Confirme em Adicionar;
- Ligue cada faixa ao provedor que deve recebê-la.
A soma dos percentuais precisa ser exatamente 100%, e o balanceador precisa ter no mínimo duas faixas. Cada faixa também precisa terminar em um provedor.
Exemplos práticos
Um provedor para cada moeda
[ Moeda é BRL? ] ──Sim──► [ PSP A ]
└──────────Não──► [ PSP B ]
Pagamentos em reais vão para o PSP A; os demais vão para o PSP B.
Provedor com alternativos
[ País é BR? ] ──Sim──► [ PSP A ] ──► [ PSP B ]
└────────Não──► [ PSP C ]
Pagamentos do Brasil vão para o PSP A e, em caso de falha, para o PSP B. Pagamentos de outros países vão para o PSP C.
Divisão por percentual
┌── 70% ──► [ PSP A ]
[ Balanceador ] ────┤
└── 30% ──► [ PSP B ]
70% das transações são processadas pelo PSP A e 30% pelo PSP B.
Combinando condições
[ Valor maior que 500? ] ──Sim──► [ PSP A ] ──► [ PSP B ]
└───────────Não────► [ Balanceador ] ─┬─ 50% ─► [ PSP A ]
└─ 50% ─► [ PSP C ]
Pagamentos acima de 500 vão para o PSP A, com o PSP B como alternativo. Os demais são divididos igualmente entre os PSPs A e C.
Ativando o fluxo
Na lista de fluxos, use o botão de status para ativar ou desativar um fluxo. O status muda imediatamente e passa a valer para as próximas transações.
Só pode existir um fluxo ativo por método de pagamento. Se você salvar um novo fluxo enquanto outro já está ativo, o novo é criado como Inativo. Para usá-lo, desative primeiro o fluxo atual e depois ative o novo.
Editando, visualizando e excluindo
| Ação | O que acontece |
|---|---|
| Editar | Abre o diagrama para alteração. Ao salvar, as mesmas validações são aplicadas. |
| Visualizar | Abre o diagrama apenas para consulta, sem permitir alterações. |
| Excluir | Remove o fluxo e todas as suas condições. A ação não pode ser desfeita. |
Alterar ou desativar um fluxo que está ativo afeta imediatamente as próximas transações. Prefira fazer mudanças em um fluxo inativo e ativá-lo quando estiver pronto.
O que acontece quando um pagamento chega
- A plataforma identifica o método de pagamento da transação;
- Localiza o fluxo ativo daquele método na sua conta;
- Percorre as condições, seguindo pelo caminho Sim ou Não conforme os dados do pagamento;
- Ao chegar em um balanceador, escolhe a faixa segundo os percentuais configurados;
- Ao chegar no provedor, verifica se ele está ativo e com credenciais válidas;
- Envia o pagamento para o provedor. Se houver alternativos configurados e o primeiro falhar, tenta o seguinte na ordem de prioridade.
Mensagens que você pode encontrar
| Mensagem | O que fazer |
|---|---|
É necessário selecionar ao menos uma condição para este PSP. | Adicione ao menos uma condição antes de salvar o fluxo. |
O fluxo deve ter ambos os caminhos (sim e não) para ser válido | Alguma condição está com uma das saídas solta. Ligue os caminhos Sim e Não. |
O fluxo não termina com um PSP | Algum caminho não chega a um provedor. Finalize todos os caminhos com um bloco de PSP. |
O nome do PSP principal não pode ser nulo | Um bloco de provedor ficou sem provedor selecionado. Abra o bloco e escolha um. |
Já existe um fluxo ativo para este método de pagamento | Desative o fluxo atual antes de ativar o novo. |
A soma das % deve ser igual a 100% | Ajuste os percentuais do balanceador para somarem exatamente 100. |
Nenhum PSP disponível para a moeda: ... | Nenhum provedor da sua conta atende essa moeda. Escolha outra moeda ou contrate um provedor compatível. |
Nenhum PSP disponível para o país: ... | Nenhum provedor da sua conta atende esse país. |
Nenhum PSP disponível para a bandeira de cartão: ... | Nenhum provedor da sua conta aceita essa bandeira. |
Moeda ... não suportada pelo PSP: ... | O provedor escolhido não opera com essa moeda. Escolha outro provedor ou ajuste a condição. |
País ... não suportado pelo PSP: ... | O provedor escolhido não opera nesse país. |
Boas práticas
- Use nomes que identifiquem a regra do fluxo, não apenas números;
- Configure ao menos um provedor alternativo para os caminhos mais usados;
- Monte e revise o fluxo com ele inativo e só então faça a troca;
- Depois de ativar, faça uma transação de teste para confirmar o comportamento;
- Ao contratar um novo provedor, lembre-se de editar os fluxos que devem passar a usá-lo.
Perguntas frequentes
Posso ter mais de um fluxo para o mesmo método de pagamento?
Sim. Você pode manter vários fluxos criados, mas apenas um pode ficar ativo por método de pagamento.
Posso trocar o método de pagamento de um fluxo já criado?
Não. O método é definido no momento da criação. Para outro método, crie um novo fluxo na aba correspondente.
O que acontece se eu desativar todos os fluxos de um método?
As transações desse método deixam de ser processadas. Mantenha sempre um fluxo ativo para cada método que você utiliza.
Preciso alterar o fluxo ao contratar um novo provedor?
Sim. O provedor passa a aparecer como opção, mas só recebe pagamentos depois de ser incluído em um fluxo ativo.
Por que meu fluxo foi criado como inativo?
Porque já existia outro fluxo ativo para o mesmo método de pagamento. Desative o anterior e ative o novo.