Welcome to Zuora Product Documentation

Explore our rich library of product information

Payment Gateway Routing

Use Payment Gateway Routing to define custom rules that route payment transactions to preferred gateways, handle failover scenarios, and improve transaction success rates and costs.

Payment Gateway Routing is a feature powered by Zuora, which allows you to route transactions to preferred payment gateways and to handle fallback scenarios in case those transactions fail. It is helpful to lower costs and increase the success rate of transactions.

You are able to define your own custom rules for processing payments through the specified payment gateway. The rules determine when a gateway should be changed from the default, how to categorize transactions and route to specified gateways, and whether to immediately retry those transactions on subsequent failover gateways. You can specify conditions based on attributes of payments, payment methods, and gateway response.

When the Payment Gateway Routing feature is enabled, the payment transaction will follow the routing rule to determine the payment gateway to use. However, if a gateway is specified in your payment API request, the routing rule will not be triggered, and the specified gateway will be used.

If the execution of the routing rule is not successful because no routing rule matches or the Payment Gateway Routing service is unavailable, the default gateway will be used. The default gateway of the customer account takes precedence over the default gateway of the tenant.

Currently, the trigger of the routing rule execution can be payment processing from the following sources:

  • Payment Run
  • Zuora UI
  • Payments API
  • Subscriptions API
  • Hosted Form
  • Hosted Payment Page
  • Payment Method API
  • Update Payment Method API
  • Authorization API
  • Verify Payment Method API

The following diagram illustrates the logic of using which payment gateway in payment processing.

Limitations

  • If a rule execution assigns a gateway that does not support an operation, the system will not generate a payment transaction log row or a payment method transaction log row for the applicable execution, depending on the situation.
  • Gateway failovers in 3DS2 applicable scenarios are not supported.
  • DirectPOST, POST_Account, POST_PaymentMethodsDecryption, and POST_Order are not supported.
  • Zuora does not support Gateway Routing for the Apple Pay payment method in the Payment Form.