Payment flows

A payment flow tells Vipter which of your connected accounts (Pagar.me, Stripe, Mercado Pago…) charges each sale. With it, you send sales in reais to one account and sales in dollars to another, or try a second account when the first one declines the card.

How a flow worksCopy Anchor Link

Open Payments›Payment flows. The screen has a tab for each payment method: Credit card, Debit card and PIX. The Boleto and Wallet tabs show as Soon, because no provider you can connect charges those methods yet.

Each flow has three parts:

• Rules, evaluated from top to bottom. A rule is either a condition (for example, "the currency is BRL") with two branches, YES and NO, or an account that tries to charge.
• Accounts in sequence. In the same branch, the first account gets the Primary badge and the next ones are fallbacks (Fallback 1, Fallback 2). When an account declines with an error that allows a retry, the next one in the same branch tries to charge.
• Default connector: charges when no rule applies and is the last attempt in every branch.

Only one flow is active per payment method. Without an active flow the checkout hides this method. Create a flow with the default connector and add rules later.

Step 1: create the flowCopy Anchor Link

1. In Payments›Payment flows, choose the payment method's tab.
2. Click Create flow.
3. Fill in the New flow window:
   • Name: a name to recognize the flow, such as "Brazil cards".
   • Payment method: already selected when you open it from the tab.
   • Default connector: the account that charges when nothing else applies. The list shows only active accounts that accept this payment method. Stripe, for example, never shows up in the PIX flow.
   • Activate now: when on, the new flow immediately replaces the active flow for this method.
4. Click Create.

With no rules, every sale goes to the default connector. To build rules, start from a template or add conditions and accounts one by one.

Step 2: start from a templateCopy Anchor Link

While the flow has no rules, the screen shows Start from a template. Pick a layout and adjust it later:

Click Apply template. Templates can only be applied to an empty flow.

Step 3: add conditionsCopy Anchor Link

1. In the Flow board, click Condition at the point where the rule should go.
2. Choose the Field, the Operator and the Value.
3. Click Save.

Fields you can use:

is one of and is not one of accept several values at once, such as "BRL, ARS". matches pattern compares the value with a regular expression and is meant for advanced cases.

Step 4: choose the accounts and the fallback orderCopy Anchor Link

1. Inside a branch, click Connector.
2. In Provider connector, choose the account. Only accounts whose provider accepts the flow's payment method show up.
3. In card flows, choose the 3D Secure setting:
   • 3DS if supported: Use 3D Secure whenever the provider and the card support it (default).
   • 3DS always: Require 3D Secure on every charge. Unsupported cards are declined.
4. Click Save.

Add another account below the first one to have a fallback. Use Move up and Move down to change the order of the accounts; conditions stay where they are. Remove deletes the step and everything below it.

Step 5: check and activateCopy Anchor Link

The Validation card, next to the flow, checks:

• Default connector is set
• Default connector is active
• All referenced connectors are active
• Default connector and rule connectors support this method
• At least one rule exists (warning only)
• Every condition leads to a connector (warning only)

The first four items block activation. When everything passes, you see All checks passed. The flow is ready to be activated.

Right below, the In plain words card describes the flow in sentences. Read it before activating: it is the fastest way to see whether the order of the accounts is what you had in mind.

To activate, click Activate at the top of the flow and confirm. If there are still open issues, Vipter shows This flow cannot be activated with the list of what to fix and a shortcut to each account.

Activate, deactivate and keep more than one flowCopy Anchor Link

• You can have several flows for the same payment method, for example one in use and another in the works. When there is more than one, the Flows for this method selector switches the flow on display. The number next to the name (v1, v2…) is the flow's version.
• Activating a flow deactivates the one that was active for that payment method.
• Deactivate leaves the method with no active flow, and the checkout stops offering it.
• Rename only changes the name. Delete flow deletes the flow.

Example: reais on Pagar.me with Mercado Pago as fallback, other currencies on StripeCopy Anchor Link

You sell in Brazil and abroad. You want sales in reais to go through Pagar.me, Mercado Pago to try again when Pagar.me declines, and sales in other currencies to go to Stripe.

1. Connect the three accounts, all of them production accounts. See Pagar.me, Mercado Pago and Stripe.
2. On the Credit card tab, create a flow with Stripe as the Default connector.
3. Apply the By currency template: currency BRL, First provider Pagar.me, Second provider (optional) Stripe.
4. In the YES branch, below Pagar.me, click Connector and choose Mercado Pago.
5. Check the In plain words card. In other words, it should say: if the currency is BRL, try Pagar.me and then Mercado Pago; otherwise, try Stripe; any other transaction goes to Stripe.
6. Click Activate.
7. Repeat on the PIX tab with Pagar.me as the default connector and Mercado Pago as the fallback. Stripe does not charge PIX.

The default connector is also the last attempt in the YES branch. If Pagar.me and Mercado Pago both decline a sale in reais, Stripe tries last.

Common problemsCopy Anchor Link

• A flow cannot mix live and test connections. This flow already uses live connections and the one you picked is in test mode (or the other way round). Create a separate flow for test connections.

  You chose a test account in a production flow, or the other way around. Use accounts of the same kind or create a flow just for testing.

• No active connector supports this payment method.

  No active account accepts this payment method. Connect a provider that does, such as Pagar.me for PIX, or reactivate the account in Payments›Providers.

• This connector does not support the flow’s payment method.

  The chosen account does not charge the flow's payment method. Choose another account.

• This flow already has rules.

  Templates only go into flows with no rules. Remove the rules or build the layout by hand with steps 3 and 4.

• The tab shows Inactive · error

  Marked active on the platform, but validation failed. The checkout cannot charge through it until the items below are fixed. Usually, an account in the flow was deactivated. Reactivate the account or swap it in the flow.

What to do nextCopy Anchor Link

• Offer installments on sales in reais in Installments and interest.
• Make a test purchase to see the flow charging: test your store.