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

# List Providers

> Returns available Mobile Money providers for a country, with fees and availability.

<Tip>
  Use this endpoint to populate the payment method selector in your player interface. Filter by `supported_directions` to show only providers that support the operation you need (deposit or withdrawal).
</Tip>

Currently supported country: **CM** (Cameroon). Pass `CM` as the `country` path parameter.


## OpenAPI

````yaml GET /api/v1/{country}/providers
openapi: 3.1.0
info:
  title: Winam Payments API
  description: >

    ## winam-payments — Mobile Money API


    Payment abstraction layer between your **sportsbook or frontend platform**
    and Mobile Money providers in Cameroon (MTN MoMo, Orange Money).


    ### Deposit flow

    1. Your platform calls `POST /api/v1/deposits` with a unique `reference`

    2. winam-payments triggers a USSD collection on the merchant SIM

    3. The player receives a notification on their phone and confirms with their
    PIN

    4. The confirmation SMS is received → transaction `succeeded`

    5. Webhook sent to your `callback_url`


    ### Withdrawal flow

    1. Your platform calls `POST /api/v1/withdrawals`

    2. A Winam operator approves manually

    3. winam-payments sends the USSD transfer

    4. Result webhook sent to your `callback_url`


    ### Authentication

    All requests to `/deposits` and `/withdrawals` must include the header:

    ```

    X-API-Key: <your_api_key>

    ```

    In development (`SPORTSBOOK_API_KEY` empty), authentication is disabled.


    ### Full documentation

    See [docs.winampay.de](https://docs.winampay.de) for the complete public
    documentation with guides, examples, and interactive playground.
  contact:
    name: Eins Innovativ
    email: support@eins-innovativ.de
  version: 0.1.0
servers: []
security: []
tags:
  - name: deposits
    description: >-
      Initiate Mobile Money deposits. The player receives a USSD notification on
      their phone to confirm payment.
  - name: withdrawals
    description: >-
      Initiate Mobile Money withdrawals. Requires manual approval from a Winam
      operator before execution.
  - name: transactions
    description: >-
      Query and manage existing transactions. Use for status polling or incident
      recovery.
  - name: providers
    description: >-
      List available providers and detect the operator from an MSISDN. Use to
      populate payment options in your player interface.
  - name: security
    description: >-
      Public key endpoint for verifying JWT signatures on outbound webhooks.
      Fetch this key once and cache it.
paths:
  /api/v1/{country}/providers:
    get:
      tags:
        - providers
      summary: Mobile Money provider catalogue
      operationId: list_providers_api_v1__country__providers_get
      parameters:
        - name: country
          in: path
          required: true
          schema:
            type: string
            title: Country
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderCatalogResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    ProviderCatalogResponse:
      properties:
        country_code:
          type: string
          title: Country Code
        providers:
          items:
            $ref: '#/components/schemas/ProviderCatalogItem'
          type: array
          title: Providers
      type: object
      required:
        - country_code
        - providers
      title: ProviderCatalogResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProviderCatalogItem:
      properties:
        provider_id:
          type: string
          title: Provider Id
          description: Internal provider identifier
          examples:
            - sim_gateway_mtn
        display_name:
          type: string
          title: Display Name
          description: Human-readable name
          examples:
            - MTN Mobile Money
        logo_url:
          type: string
          title: Logo Url
          description: URL to the provider logo image
        operators:
          items:
            type: string
          type: array
          title: Operators
          description: Supported MoMo operators
          examples:
            - - mtn
        supported_directions:
          items:
            type: string
          type: array
          title: Supported Directions
          description: Supported directions
          examples:
            - - deposit
              - withdrawal
        deposit_fee_percent:
          type: number
          title: Deposit Fee Percent
          description: Fee applied to deposits (0.0 = no fee)
          examples:
            - 0
        deposit_fee_message:
          type: string
          title: Deposit Fee Message
          description: Human-readable fee description
          examples:
            - No fees
        withdrawal_fee_percent:
          type: number
          title: Withdrawal Fee Percent
          description: Fee applied to withdrawals
          examples:
            - 0
        description:
          type: string
          title: Description
          description: Provider description
        is_primary:
          type: boolean
          title: Is Primary
          description: Whether this is the primary (preferred) provider for its operators
        is_available:
          type: boolean
          title: Is Available
          description: Real-time availability (derived from feature flags)
        status:
          type: string
          title: Status
          description: >-
            Real-time status: `"active"` | `"degraded"` | `"unavailable"` |
            `"unknown"`
          examples:
            - active
      type: object
      required:
        - provider_id
        - display_name
        - logo_url
        - operators
        - supported_directions
        - deposit_fee_percent
        - deposit_fee_message
        - withdrawal_fee_percent
        - description
        - is_primary
        - is_available
        - status
      title: ProviderCatalogItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````