# Fetch Biller List

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v2/biller:
    get:
      summary: Fetch Biller List
      deprecated: false
      description: >-

        :::highlight purple 💡

        This API allows you to retrieve a list of billers supported by BBPS.

        It accepts two optional parameters:

        - `billerType`: Returns the list of billers for a specific category (for
        example, electricity, water, telecom).

        - `stateCode`: Returns the list of billers available for a specific
        state code.

        :::


        :::note[]

        Note:

        If both `billerType` and `stateCode` are not provided, the API will
        return all supported billers, which may result in a very large response
        payload. It is recommended to use at least one of these parameters to
        narrow down the results and optimize performance.

        :::
      operationId: getBillers
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill
        - Bill Payment
      parameters:
        - name: billerType
          in: query
          description: ''
          required: false
          schema:
            type: string
            enum:
              - ELECTRICITY
              - GAS
              - WATER
              - BROADBAND
              - INSURANCE
              - DTH
              - PREPAID
              - LANDLINE
              - POSTPAID
              - DATACARD
              - DATACARD_BP
              - EMI
              - FASTag
              - MUNICIPALITY
              - LPG_BOOKING
              - CABLE_TV
              - CLUBS_ASSOCIATIONS
              - CREDIT_CARD
              - EDUCATION_FEES
              - HEALTH_INSURANCE
              - HOSPITAL_PATHOLOGY
              - HOUSING_SOCIETY
              - LIFE_INSURANCE
              - LOAN_REPAYMENT
              - MUNICIPAL_SERVICES
              - MUNICIPAL_TAXES
              - RECURRING_DEPOSIT
              - SUBSCRIPTION
              - OTHERS
        - name: stateCode
          in: query
          description: ''
          required: false
          schema:
            type: string
            enum:
              - AndhraPradesh
              - ArunachalPradesh
              - Assam
              - Bihar
              - Chattisgarh
              - Goa
              - Gujarat
              - Haryana
              - HimachalPradesh
              - JammuAndKashmir
              - Jharkhand
              - Karnataka
              - Kerala
              - MadhyaPradesh
              - Maharashtra
              - Manipur
              - Meghalaya
              - Mizoram
              - Nagaland
              - Orissa
              - Punjab
              - Rajasthan
              - Sikkim
              - TamilNadu
              - Telangana
              - Tripura
              - Uttarakhand
              - UttarPradesh
              - WestBengal
              - AndamanAndNicobar
              - Chandigarh
              - DadraandNagarHaveli
              - DamanAndDiu
              - Delhi
              - Lakshadweep
              - Pondicherry
              - INVALID_STATE_CODE
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponseListBillerResponse'
          headers: {}
          x-apidog-name: OK
      security:
        - bearer: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664795-run
components:
  schemas:
    ApplicationResponseListBillerResponse:
      type: object
      properties:
        response_code:
          type: integer
          format: int32
        response_message:
          type: string
        payload:
          type: array
          items:
            $ref: '#/components/schemas/BillerV2Response'
      x-apidog-orders:
        - response_code
        - response_message
        - payload
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    BillerV2Response:
      type: object
      properties:
        billerId:
          type: integer
        name:
          type: string
        billerType:
          type: string
        partialPayAllowed:
          type: boolean
        inputParams:
          type: array
          items:
            type: object
            properties:
              paramKey:
                type: string
              paramName:
                type: string
              paramType:
                type: string
              paramRegex:
                type: string
              invalidParamError:
                type: string
              mandatory:
                type: boolean
              paramValues:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    value:
                      type: string
                  x-apidog-orders:
                    - key
                    - value
                  x-apidog-ignore-properties: []
            x-apidog-orders:
              - paramKey
              - paramName
              - paramType
              - paramRegex
              - invalidParamError
              - mandatory
              - paramValues
            x-apidog-ignore-properties: []
        circleParams:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            x-apidog-orders:
              - key
              - value
            x-apidog-ignore-properties: []
        paymentAmountExactness:
          type: string
        state:
          type: string
        circleStateMapping:
          type: object
          properties:
            additionalProp1:
              type: string
            additionalProp2:
              type: string
            additionalProp3:
              type: string
          required:
            - additionalProp1
            - additionalProp2
            - additionalProp3
          x-apidog-orders:
            - additionalProp1
            - additionalProp2
            - additionalProp3
          x-apidog-ignore-properties: []
        viewBillSupported:
          type: boolean
      required:
        - billerId
        - name
        - billerType
        - partialPayAllowed
        - inputParams
        - circleParams
        - paymentAmountExactness
        - state
        - circleStateMapping
        - viewBillSupported
      x-apidog-orders:
        - billerId
        - name
        - billerType
        - partialPayAllowed
        - inputParams
        - circleParams
        - paymentAmountExactness
        - state
        - circleStateMapping
        - viewBillSupported
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```