Skip to main content

Channel Types

1. Overview​

The Channel Types module in Sumo Ledger allows administrators to define the various channels through which transactions can flow into the ledger system. A channel represents a source or pathway for transactions --- such as a mobile app, web portal, API integration, branch counter, or third-party payment gateway.

Channels are a foundational configuration element. Once defined, they can be assigned to user types (to control which users can transact through which channels), referenced in transaction controls (to set channel-specific limits), and used for filtering and reporting.

Navigation: Configurations > Accounting Settings > Channel Types

URL: https://las.ledger.raralabs.dev/settings/channels/list

2. Channel Types List View​

The list view displays all configured channels in a table with the following columns:

ColumnDescription
NameThe display name of the channel (expandable with a toggle arrow).
IDThe unique system identifier for the channel.
Is WildcardIndicates whether this channel acts as a wildcard, matching any unspecified channel.
StagesThe processing stages associated with this channel, if any.

When no channels have been configured, the list displays "No results."

List View Actions​

  • + New Type: Opens the form to create a new channel type.

3. Creating a New Channel Type​

Click "+ New Type" in the top-right corner. A modal dialog titled "Add Channel" opens with the following field:

3.1 Channel Name​

A text field where you enter the name of the new channel. This name serves as both the display label and the system reference.

Guidelines:

  • Use lowercase with underscores for consistency (e.g., mobile_app, web_portal, api_gateway, branch_counter).
  • Keep names descriptive enough that other administrators can understand what the channel represents without additional context.
  • Channel names should be unique across the system.

3.2 Saving​

Click "Add Channel" to create the channel type.

4. Editing an Existing Channel Type​

Click on any row in the list to view or edit the channel's details. The expandable row may reveal additional configuration options or associated stages.

5. How Channel Types Work in Practice​

Integration with Other Modules​

Channel Types connect to several other parts of the system:

User Types: When configuring a user type, you assign one or more channels to it. This determines which channels that user type is allowed to transact through. For example, an admin user type might have access to all channels, while a customer user type might only have access to mobile_app and web_portal.

Transaction Controls: When creating transaction controls scoped to the Channel model, you select a channel from this list. This lets you set amount and balance limits that apply only to transactions coming through a specific channel.

Transaction Processing: When a transaction is submitted, the system checks which channel it arrived through and applies the appropriate controls and policies.

Example​

Suppose your organization accepts transactions from three sources:

  1. A mobile banking app
  2. A web-based admin portal
  3. A direct API integration for bulk processing

You would create three channel types: mobile_app, admin_portal, and bulk_api. Then:

  • Assign mobile_app and admin_portal to customer-facing user types.
  • Assign all three to the admin user type.
  • Set lower transaction limits on mobile_app and higher limits on bulk_api.

6. Best Practices​

  1. Define channels early. Channels are referenced by user types and transaction controls, so they should be set up before configuring those modules.
  2. Use a consistent naming convention. Stick to snake_case (e.g., mobile_app) for uniformity across the system.
  3. Create a default or wildcard channel if you need a catch-all for transactions that don't specify a channel.
  4. Be specific rather than generic. A channel named partner_api_xyz is more useful than api when you have multiple API integrations.
  5. Review channel assignments regularly. As new transaction sources are added or deprecated, update the channel list accordingly.