Get Routes

Body Parameters

Field NameData TypeDescriptionStateExample Value
routesarrayAn array of route objects.Mandatory
routes.idstringUnique identifier for the route.Mandatory"fcac4af0-68ef-eb11-a864-dc41a9f8739c"
routes.categorystringCategory of the route.Mandatory"1"
routes.categoryDescriptionstringDescription of the category.Mandatory"Bank Transfer"
routes.categoryIsEnabledbooleanIndicates if the category is enabled.Mandatorytrue
routes.routeIntegrationstringThe integration name of the route.Mandatory"KCB"
routes.countrystringThe country associated with the route.Mandatory"Kenya"
routes.routeIsActivebooleanIndicates if the route is active.Mandatorytrue
routes.channelTypesarrayAn array of channel type objects associated with the route.Mandatory
routes.channelTypes.channelTypeintThe type of channel (e.g., 3 for EFT, 4 for RTGS).Mandatory3, 4
routes.channelTypes.channelDescriptionstringDescription of the channel type.Mandatory"EFT", "RTGS"