Skip to main content
GET
Retrieve a Routing
Returns the routing’s current live configuration, in the same shape Create a Routing and Update a Routing accept, so you can send the result back in a PATCH. Compared with a request body, the response also carries:
  • retry on every output (false when not set).
  • group_id, group_name and decline_types on DECLINE_GROUP and MAC_CODE_GROUP outputs; group_id and group_name on SUCCEEDED_GROUP outputs.
  • action and action_delay on action steps, and output: [] on them.
  • provider_type on every provider step, fraud on fraud steps and smart_routing on smart routing steps.
  • The schedule and limit fields of TIME_PERIOD and VOLUME_PAYMENTS_LIMIT conditions.
  • start_split when the entry is split and output[].next_split when a fallback is split; both are omitted otherwise.
  • Fields without a value come back as null (next, decline_types, key, currency); the examples below leave them out for brevity.
Parts of a routing the API cannot express are left out of the response and kept untouched on update. See What the API does not show.

Path Parameters

string
required
The id returned by Create a Routing. Must belong to the account your API key is scoped to.

Response

string
Unique identifier for the routing.
string
Unique identifier for the account.
enum
The payment method this routing applies to (e.g., CARD).
string
Label for the routing.
object
The default routing logic. See Routing Resource Shape for every field of steps[] and output[].
object[]
Optional conditional logic.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
string[]
Optional list of non-blocking orchestration warnings (e.g., MONITOR_REDISTRIBUTION_DEFERRED).

Errors

Authorizations

PUBLIC-API-KEY
string
header
default:<Your PUBLIC-API-KEY>
required
PRIVATE-SECRET-KEY
string
header
default:<Your PRIVATE-SECRET-KEY>
required

Path Parameters

routing_id
string<uuid>
required

Response

OK

id
string
Example:

"8f2c1d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f"

account_id
string
Example:

"acc-uuid"

payment_method
string
Example:

"CARD"

name
string
Example:

"Card routing — Stripe primary, Adyen fallback"

default_route
object
condition_sets
object[]
created_at
string<date-time>
Example:

"2026-05-12T14:30:00Z"

updated_at
string<date-time>
Example:

"2026-05-12T14:30:00Z"