> ## Documentation Index
> Fetch the complete documentation index at: https://docs.palpluss.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payment Channels

> Fetch all payment channels registered to your account.

Retrieve every active payment channel (M-Pesa Paybill / Till shortcode) on your account. Use this to discover the `channelId` values you pass when initiating an STK Push.

## Ordering

Channels are returned with the **default channel first**, then newest to oldest. Soft-deleted channels are never returned.

```json theme={null}
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "8b3f1a2c-0000-0000-0000-000000000001",
        "tenantId": "b6fbe75f-ce87-4d44-b318-6cfdb8b7de4d",
        "category": "PAYMENT_WALLET",
        "type": "PAYBILL",
        "shortcode": "123456",
        "name": "Main Collections Paybill",
        "accountNumber": "ACCOUNT001",
        "isDefault": true,
        "createdAt": "2026-03-01T07:00:00.000Z"
      }
    ]
  },
  "requestId": "f4e5d6c7-0000-0000-0000-000000000000"
}
```

<Tip>
  The channel with `"isDefault": true` is the one used when you initiate an STK Push without a `channelId`.
</Tip>

```bash theme={null}
curl "https://api.palpluss.com/v1/payment-wallet/channels" \
  -u "$PALPLUSS_API_KEY:"
```


## OpenAPI

````yaml GET /payment-wallet/channels
openapi: 3.1.0
info:
  title: PalPluss API
  version: '1.0'
  summary: >-
    Payment infrastructure for Kenya — STK Push, B2C payouts, and wallet
    management.
  description: >
    The PalPluss API gives developers programmatic access to M-Pesa STK Push
    collections,

    B2C payouts, service wallet top-ups, and payment channel management.


    **Base URL:** `https://api.palpluss.com/v1`


    All requests must be authenticated with an API key using HTTP Basic Auth.

    All responses are wrapped in a standard envelope. See [Errors](#tag/errors)
    for error codes.


    Amounts are in **KES (Kenyan Shillings)** unless stated otherwise. Phone
    numbers

    are normalized to the `254XXXXXXXXX` format internally.
  contact:
    name: PalPluss Developer Support
    email: developer@palpluss.com
    url: https://palpluss.com/developers
servers:
  - url: https://api.palpluss.com/v1
    description: Production
  - url: https://sandbox.palpluss.com/v1
    description: Sandbox
security:
  - BasicAuth: []
tags:
  - name: STK Push
    description: >
      Initiate M-Pesa STK Push payment prompts. The customer receives a PIN
      prompt on their

      phone and confirms payment. PalPluss delivers the result asynchronously to
      your webhook URL.
  - name: Transactions
    description: >-
      Query the status of any transaction by ID, or list all transactions with
      filters.
  - name: B2C Payouts
    description: >
      Send money directly to a customer's M-Pesa number. Requires KYC approval
      and sufficient

      B2C wallet balance. Payouts are processed asynchronously.
  - name: Service Wallet
    description: >
      The service wallet holds pre-funded tokens used to pay PalPluss
      transaction fees.

      Top up via STK Push. Balance is deducted with each API call.
  - name: Payment Channels
    description: >
      Payment channels represent the M-Pesa shortcodes (Paybill / Till)
      associated with your

      account. Channels are used to route STK Push requests to a specific
      shortcode.
paths:
  /payment-wallet/channels:
    get:
      tags:
        - Payment Channels
      summary: List payment channels
      description: >
        Returns all active payment channels for your account, default channel
        first.

        Soft-deleted channels are excluded.
      operationId: listChannels
      responses:
        '200':
          description: Payment channels retrieved successfully.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessEnvelope'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          items:
                            type: array
                            items:
                              $ref: '#/components/schemas/PaymentChannel'
              examples:
                success:
                  value:
                    success: true
                    data:
                      items:
                        - id: 8b3f1a2c-0000-0000-0000-000000000001
                          tenantId: b6fbe75f-ce87-4d44-b318-6cfdb8b7de4d
                          category: PAYMENT_WALLET
                          type: PAYBILL
                          shortcode: '123456'
                          name: Main Collections Paybill
                          accountNumber: ACCOUNT001
                          isDefault: true
                          createdAt: '2026-03-01T07:00:00.000Z'
                    requestId: f4e5d6c7-0000-0000-0000-000000000000
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - success
        - data
        - requestId
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          description: Response payload. Shape varies by endpoint.
        requestId:
          type: string
          format: uuid
          description: Unique identifier for this API request. Include in support tickets.
          example: c1b2a3d4-e5f6-7890-abcd-ef1234567890
    PaymentChannel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tenantId:
          type: string
          format: uuid
        category:
          type: string
          example: PAYMENT_WALLET
        type:
          $ref: '#/components/schemas/ChannelType'
        shortcode:
          type: string
          example: '123456'
        name:
          type: string
          example: Main Collections Paybill
        accountNumber:
          type: string
          nullable: true
          example: ACCOUNT001
        isDefault:
          type: boolean
          example: true
        createdAt:
          type: string
          format: date-time
    ChannelType:
      type: string
      enum:
        - PAYBILL
        - TILL_NUMBER
        - SEND_MONEY
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
        - requestId
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - message
            - code
          properties:
            message:
              type: string
              description: Human-readable error description.
              example: Invalid API key
            code:
              type: string
              description: Machine-readable error code.
              example: INVALID_API_KEY
            details:
              type: object
              description: Optional structured details about the error.
        requestId:
          type: string
          format: uuid
          example: c1b2a3d4-e5f6-7890-abcd-ef1234567890
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalid_key:
              value:
                success: false
                error:
                  message: Invalid or revoked API key.
                  code: INVALID_API_KEY
                  details: {}
                requestId: a1b2c3d4-0000-0000-0000-000000000000
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >
        Paste your PalPluss API key in the **username** field and leave the

        **password** field empty — it is ignored.


        Get your key from **console → Settings → API Keys** (starts with
        `pk_live_` or `pk_test_`).


        In your own code, send the key directly:

        `Authorization: Basic YOUR_API_KEY`

````