Active Channels

This authenticated endpoint returns payment channels available to your merchant. Results are route-backed: a method is returned only when it has an active PaymentRoute assigned to an active Internal account, its underlying route is active, and its route type matches the requested transaction type.

By default, the endpoint checks active payment routes across your authenticated corporate's active Internal accounts. Supply MerchantCode to restrict results to one of those accounts. It never returns unassigned global routes.

When MerchantCode is supplied, the response's region and currency are derived from that account. All active pay-in routes assigned to the account are considered, including routes whose settlement currency differs from the account currency.

channels retains the original flat Mobile Money list for existing integrations. all_channels provides the grouped mobile, cards, and crypto breakdown. Every group is present; a disabled payment feature is represented by an empty array. Mobile methods must also be enabled for the resolved country.

Test Endpoint:

https://api.sandbox.ekonnectpay.com/api/v1/active-channels/

The following parameters are accepted:

Request parameter	Description	Example
TransactionType	Optional route type. Defaults to Payins.	Payins
MerchantCode	Optional Internal account number. Restricts channels to payment routes assigned to that account. The account must belong to the authenticated corporate.	100002
Country	Optional supported country. It determines the available Mobile Money methods and, when no currency is supplied, its local currency scope.	Tanzania
Currency	Optional ISO payment or settlement currency used to scope routes. Supply Country with a global currency such as USD or USDT.	USDT

Request Sample

curl --location --request POST 'https://api.sandbox.ekonnectpay.com/api/v1/active-channels/' \
--header 'X-Region: ke' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "TransactionType": "Payins",
    "MerchantCode": "100002"
  }'

Response Sample

{
  "code": "200.001",
  "data": {
    "region": "Kenya",
    "currency": "KES",
    "transaction_type": "Payins",
    "channels": ["MPESA"],
    "all_channels": {
      "mobile": ["MPESA"],
      "cards": ["VISA"],
      "crypto": ["USDT TRC20"]
    }
  }
}

Response Parameters

Response parameter	Description
region	Resolved country used for Mobile Money method availability.
currency	Currency used to scope active routes, when applicable.
transaction_type	Route type used for the lookup.
channels	Legacy flat list of active, enabled Mobile Money methods.
all_channels.mobile	Active, enabled Mobile Money methods assigned to the requested account or authenticated corporate.
all_channels.cards	Active, enabled card methods assigned to the requested account or authenticated corporate.
all_channels.crypto	Active, enabled crypto methods assigned to the requested account or authenticated corporate.

TIP

Always include the Authorization header with your merchant access token. Obtain one through the Authentication endpoint.