Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Routes

Search routes

Search payment routes.

get/routes

Query parameters

route_idstring

Search for specific route ID(s). Comma separate for multiple.

route_namestring

Search routes by name.

route_type_idinteger

Search for specific route ID(s). Comma separate for multiple.

  • 1 - Round Robin
  • 2 - Volume
  • 3 - Weight
route_activeboolean

Return routes with a specific active status.

with'route_merchants'

Expand on the information returned by including 'with' in the query parameters. (example : with=route_merchants)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

OK

totalstring

Example response

{
  "routes": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ]
}