Inspect routing configurations

Sign in Hub
Get help
Inspect routing configurations
Navigate, list, search, and export routing configurations, review version history, and work with routing identifiers in Hub or through the API

List routing configurations
anchor

Each channel keeps its routing configurations in one list. Use it to check what is live, find a configuration to edit, or pick the identifiers you need for API calls.

Send a request to the list routing configurations API v2 endpoint.

  • Filter by payment_method_group with EQ : CARD , DIGITAL_WALLET , MERCHANT_MANAGED_NETWORK_TOKEN , or SOLIDGATE_TOKEN .
  • Paginate with next_page_token . Omit it on the first request; the token is empty on the last page.
  • Each item returns the configuration id , title , description , channel_id , latest_version_id , and latest_published_version_id .
  • Pass id and a version identifier to get routing configuration API v2 or get routing configuration version API v2 .
To view the configuration list

  1. Go to Orchestration > Configurations.
  2. Filter the list by:
    • Channels
    • Payment method
    • Statuses Active , Inactive , or Archived . Archived configurations stay hidden until you include Archived in the status filter.

A routing configuration opens with a navigation sidebar that shows the full route hierarchy, from rule set down to rule, segment, step, and connector account. In large configurations, the sidebar turns a visual search across the canvas into a direct lookup, so you can jump straight to any entity instead of panning and zooming.

From the sidebar you can:

Browse the route tree

Rule sets group the rules of the configuration. Each rule expands into its segments with traffic percentages, and each segment into its cascade steps with connector accounts. Rules are numbered by priority.

Select any entity

Highlights it on the canvas.

Search

By entity ID or across configuration parameters to reach a specific rule without scrolling the canvas.

Act on rules

Directly from the sidebar through the actions menu, and expand or collapse the full tree in one click.

Open configuration tools

From the sidebar footer: connector account replacement, export, and version history.

The sidebar is for navigation and management. It changes how a configuration is displayed, not how payments are routed. Actions such as duplicating or reordering rules stay on the canvas, and the canvas keeps working as before. The sidebar can be collapsed at any time.

View version history
anchor

Every change to a routing configuration is saved as a numbered version. Exactly one published version is live per configuration. Earlier versions remain available in read-only mode, so you can always trace what logic processed an order at a given time.

To browse versions in Hub

  1. Go to Orchestration > Configurations.
  2. Find the routing configuration and click on it.
    The sidebar header shows the configuration name, payment method, the current version number, and its status, for example Card | Version 7 | Live.
  3. In the sidebar footer, click on Version history to see all versions of the configuration, including version number, status, publication date, and version comment.
  4. Select any version to open it on the canvas in read-only mode.
    • Live
      The published version currently processing payments.
    • Published
      A previously live version kept for history.
    • Draft
      Unpublished changes that do not affect processing.

Add descriptions and version comments
anchor

Two text fields help your team tell configurations and versions apart:

Configuration description

Describes the purpose of the whole configuration, for example Default routing for digital wallets. Returned as description by the list and get configuration endpoints.

Version comment

Explains what changed in a specific version, for example Shifted 20% of EU Visa traffic to backup acquirer. Returned as description by the get routing configuration version endpoint and shown in the version history.

To set a configuration description

  1. Go to Orchestration > Configurations and open the configuration.
  2. In the sidebar, click on the configuration name in the header to expand the details panel.
  3. Next to Configuration Details, click on Edit, update the description, and save.

To add a version comment

  1. Go to Orchestration > Configurations and open the configuration.
  2. In the sidebar, click on the configuration name in the header to expand the details panel.
  3. Next to Version Comment, click on Edit, enter the comment, and save.
    The comment appears next to the version in the version history.
A version comment can be set for the current version only. Write comments your future self can act on. Name what changed and why, not just “update”. Comments are the fastest way to connect a performance shift in analytics to the configuration change that caused it.

Export routing configuration
anchor

Export returns the full route tree of a configuration version: route sets, rules, segments, and cascade steps. Use it to audit changes, copy logic across environments, or store an external snapshot of published routing. Unlike the Guide
Generate a CSV export of routing decisions for orders in a selected date range. routing events report , the export describes the configuration itself, not the orders processed through it.

To keep an external copy of published routing up to date:

  1. Set up credentials API v2 and webhook endpoints.
  2. When a version is published, receive the routing configuration version published Webhook notification.
  3. From the payload, take data.routing_config.id as config_id and data.routing_config.latest_published_version_id as the version id .
  4. Send a request to get routing configuration version API v2 with config_id and id .
    The response includes the full route tree for that version.
To export from Hub

  1. Go to Orchestration > Configurations.
  2. Find the routing configuration and click on it.
  3. Navigate to the configuration version you need.
  4. Click on Export in the sidebar footer.

Work with routing identifiers
anchor

Every routing entity carries identifiers with a recognizable prefix. Use them to reference an exact configuration, route, or step in API calls, in support requests, and when connecting routing analytics to the canvas.

IdentifierPrefixRefers toStable across versions
Configuration IDcfg_The routing configuration as a wholeYes, never changes
Configuration version IDcfgv_One specific version of a configurationNo, each version gets its own ID
Route IDrt_A route within a configuration versionNo, regenerated with each published version
Step IDstp_A cascade step within a segmentNo, regenerated with each published version
Analytics route IDart_The same logical route, tracked over timeYes, until the route's rule condition changes
Analytics segment IDarc_The same logical split group, or cascade, tracked over timeYes, until the cascade or its steps change
Analytics step IDars_The same logical step, tracked over timeYes, until the step's setup changes

Regular IDs vs analytics IDs:

Regular IDs

rt_, stp_, and cfgv_ identify an entity inside one specific configuration version. Publishing a new version issues new regular IDs, even when the route or step itself did not change. Use them to pin down exactly which version processed an order.

Analytics IDs

art_, arc_, and ars_ identify the logical entity across versions. They carry forward from version to version as long as the entity keeps the same identity, and regenerate the moment it changes. Use them to aggregate performance of a route, segment, or step over time in your own analytics, without breaking the series on every publish.

An analytics ID regenerates when:

Analytics route ID

The route's rule condition changes. Renaming a route or changing its priority does not regenerate the ID.

Analytics segment ID

A step is added to or removed from the cascade, or any step in it changes identity.

Analytics step ID

The step's connector account, processing method, descriptor, forced 3DS setting, or position in the cascade changes.

When an analytics ID regenerates, treat it as a new entity in your reports. The old ID stops appearing in new routing events, and the new ID starts a fresh series. A break in the series is itself a signal that the routing logic changed at that point.

You find identifiers in:

  • Each row of the routing events report, which includes configuration_id, configuration_version_id, route_id, analytics_route_id, step_id, analytics_step_id, and analytics_segment_id for every order.
  • On the configuration version page, where opening a route shows its route_id and analytics_route_id on the rule card, and opening Configure steps shows the analytics_segment_id of the split group and the step_id and analytics_step_id of each step. Use the copy button next to each identifier.
  • The entity ID search in the sidebar, where pasting any identifier jumps straight to the entity on the canvas.
  • The routing event log, which shows the same entities except analytics IDs.
Typical flow: find an underperforming step in the routing events report, copy its step_id, paste it into the entity ID search on the configuration list, and land directly on that step in the exact version that processed the orders.

Find entities by ID
anchor

The entity ID search accepts a configuration ID, configuration version ID, route ID, or step ID, as well as analytics IDs such as art_, arc_, ars_, and opens the matching entity on the canvas. Searching by an analytics ID locates the route, segment, or step it currently identifies, useful when you come from the routing events report or your own analytics.

To search from the configuration list

  1. Go to Orchestration > Configurations.
  2. In the routing entity search field, enter an identifier. Depending on its type:
    • Configuration opens the latest published version of the configuration in a new window.
    • Configuration version opens that specific version in a new window.
    • Route opens the version that contains the route in a new window. The route is centered and highlighted.
    • Step opens the version that contains the step in a new window. The step is shown in the drawer and highlighted.

To search on the configuration version page

  1. Open a routing configuration and navigate to a specific version.
  2. In the sidebar search field, enter a configuration version ID, route ID, or step ID:
    • Configuration version highlights in place when it is the current version. Otherwise opens in a new window and highlights.
    • Route centers and highlights the route in the current version, or opens the matching version in a new window.
    • Step opens in the drawer and highlights in the current version, or opens the matching version in a new window.

Search routes by condition parameters
anchor

When you know the rule but not the ID, for example which routes handle AMEX in Poland, filter routes on a configuration version page by their condition parameters.

To search by params

  1. Go to Orchestration > Configurations and open a configuration version.
  2. In the sidebar, click on Search by params.
  3. Open Search for routes where and add conditions:
    • Condition parameter, for example Country, Bank, BIN Country, Card Brand, Card Type, Currency, or Data Origin.
    • Operator offered for that parameter.
      The default is Contains all, meaning all chosen values must be present in the route’s condition.
    • One or more values.
  4. Between rows, set AND or OR.
  5. Click on Search and choose how results are shown:
    • Show only matching
      Other branches collapse or hide. A banner can note that only selected branches are shown.
    • Highlight matches
      Matching routes stand out. Other branches stay visible but de-emphasized. Use Show all or Deselect all to reset.

Looking for help? Contact us
Stay informed with Changelog