Route payments to multiple processorsPrivate preview

Rules contain the conditions and actions for routing payments to a specific processor.

1. Create a sandbox if you don’t have an existing one. You use the sandbox to add and test rules before going live.
2. On the Orchestration page in the Dashboard, click Add rules.
3. Add rules with a condition that routes the payment to one of the available processors if the Card country is equal to United Kingdom. Add an action to route the payment to Stripe if the condition isn’t met.
4. Click Activate test rules.

When you create a PaymentIntent, include the payments_orchestration parameter to enable Orchestration.

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=500 \
  -d currency=usd \
  -d "payment_method_types[]"=card \
  -d payment_method=pm_card_visa \
  -d "payments_orchestration[enabled]"=true \
  -d confirm=true

Orchestration doesn’t support the Setup Intents API and flexible acquiring features on other processors. For transactions that involve a 3D Secure request, you’re responsible for providing Stripe with the Acquirer BIN that corresponds to the processor you route those transactions to. Check with your Stripe representative if you’re unsure whether Orchestration supports the features you use.

Use test cards to make sure Stripe routes payments to the processors specified by your rules. For example, to test if payments route to the processor you selected when the card country equals the United Kingdom, you can use the test payment method pm_card_gb:

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=12345 \
  -d currency=gbp \
  -d "payment_method_types[]"=card \
  -d payment_method=pm_card_gb \
  -d "payments_orchestration[enabled]"=true \
  -d confirm=true

After creating a test payment, view the details page for your payment to see which processor the payment routed to. On the payment details page, you can see the processor under Processor. Recent activity also shows the processor and the rules that routed the payment. Click the link to view the rules that routed this payment.

The Payment Record contains the execution history for payments where Orchestration is enabled. Retrieve the Payment Record using its ID from the PaymentIntent.

curl https://api.stripe.com/v1/payment_records/{{PAYMENT_RECORD_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

Alternatively, enter the Payment Record ID in the Inspector in Workbench.

Verify which processor the payment routed to by viewing the processor_details hash:

{
  "id": "pr_123456",
  "object": "payment_record",
  "amount_authorized": {
    "currency": "gbp",
    "value": 12345
  },
  ...
  "processor_details": {
    "type": "processor_a",
    ...
  },
  ...
}

After testing your integration, exit your sandbox and add rules for your live integration. Orchestration is enabled as soon as you activate your rules. Learn about other conditions and actions to route payments.

Monitor processor performance

After enabling Orchestration for your live payments, use the Dashboard to monitor performance for your processors.

• On the Orchestration overview page, access performance analytics and payment success rates across your processors. You can filter this data to see performance by currency, card brand, card country, card type, or transaction type.
• On the Payment details page, view processor information for an individual payment.
• On the Payments analytics page, analyse your overall payment success rate to find out where payments fail. Use the processor filter to view only the payments routed through a specific processor.

The Dashboard doesn’t currently display balance summary and activity reports, dispute status, or receipts for payments processed on other processors. Data can take up to 2 days to populate. The Orchestration data that we share in the Dashboard relies on data provided by you and your other processors.