Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Routes

Get a route

 

get/routes/{route_id}

Query parameters

with'route_merchants'

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

Response

OK

route_idinteger
route_namestring
route_type_id1 | 2 | 3
  • 1 - Round Robin
  • 2 - Volume
  • 3 - Weight
route_include_declineboolean
route_force_itemsboolean
merchant_auto_activeboolean
merchant_auto_active_countinteger
route_activeboolean
route_notesstring
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger

Example response

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