Skip to navigation

Get Processor Route

View as Markdown
Get a single processor route by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

route_idstringRequired
account_idstringRequired

Response

Successful Response
idstring
Unique route identifier
namestring
Route name
processorslist of objects

Ordered list of processors (empty when the route lists routes, or is a stop route)

routeslist of objects

Ordered list of route steps (empty when the route lists processors, or is a stop route)

conditionslist of objects

When this route applies. Empty (the default) means always. A route with conditions is what the dashboard calls a routing rule: give it a position to evaluate it in your account’s rule order, or point another route, a checkout session or a payment link at it.

match_modeenum
Whether ALL conditions must match or ANY one of them
Allowed values:
versioninteger
Current route version. Increments on each configuration edit.
statusenum
Route lifecycle status
Allowed values:
typeenum

How the route uses its steps. Defaults to standard_cascade. standard_cascade: try in order, any failure advances. last_successful_first: the processor that last approved the card is tried first; the list is the fallback order (processors only). last_successful_only: charge the processor that last approved the card and stop — no fallback. Takes no steps at all (dynamic per card). failover: exactly two processors; the backup fires only on error or timeout, never on a decline (processors only). weighted: split by percentage; weights must sum to 100. stop: no steps at all — a matching stop route halts the payment before any processor is tried.

created_atdatetime
When the route was created
updated_atdatetime
When the route was last updated
descriptionstring or nullOptional
Route description
positioninteger or nullOptional

The route’s place in your account’s evaluation order (1 = evaluated first), or null when it is not evaluated on its own — only reachable by reference from another route, a session, a pin, or as the account default. On create and update, the route is inserted at that position and the others shift down; a value past the end appends. Use POST /processor-routes/reorder to set the whole order at once.

Errors

422
Unprocessable Entity Error