openapi: 3.2.0
info:
  title: Falcon Aggregator API
  version: '1.0'
  description: 'Operations tagged Aggregator across 2 of this provider''s published API definitions: falcon-add-an-aggregator-openapi.yml, falcon-view-a-list-of-enterprises-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
tags:
- name: Aggregator
paths:
  /aggregator:
    post:
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - aggregatorName
              - aggregatorType
              - registeredName
              - adminName
              - adminEmail
              - officialEmailID
              properties:
                aggregatorName:
                  type: string
                  description: The name of the aggregator you want to add.
                  example: Volopay
                aggregatorType:
                  type: string
                  description: The type of the aggregator.
                  example: Corporate
                registeredName:
                  type: string
                  description: The registered name of the aggregator.
                  example: VP Technologies
                officialDocumentType:
                  type: string
                  description: The CIN/TIN/PAN/GSTIN associated with the aggregator.
                  example: CIN
                officialDocumentID:
                  type: string
                  description: The CIN/TIN/PAN/GSTIN of the aggregator.
                  example: 22AAAAA0000A1Z5
                address:
                  type: string
                  description: The official address of the aggregator.
                  example: 3rd floor, VV Complex, Sector 4
                website:
                  type: string
                  description: The official website of the aggregator.
                  example: vptech.com
                adminName:
                  type: string
                  description: The name of the administrator/POC of the aggregator.
                  example: Amit
                adminTitle:
                  type: string
                  description: The title of administrator/POC of the aggregator that has to be onboarded.
                  enum:
                  - Master
                  - Mr.
                  - Mrs.
                  - Ms.
                  example: Mr.
                adminNumber:
                  type: string
                  description: The contact number of administrator/POC of the aggregator.
                  example: '9910101010'
                adminEmail:
                  type: string
                  description: The email ID of administrator/POC of the aggregator.
                  format: email
                  example: amit@vptech.com
                supportEmail:
                  type: string
                  description: The support email ID of the aggregator.
                  format: email
                  example: support@vptech.com
                supportNumber:
                  type: string
                  description: The support contact number for the aggregator.
                  example: 01204116782
                agreement:
                  type: string
                  description: The duly signed agreement file.
                  example: agfalvp.pdf
                approvalLetter:
                  type: string
                  description: The duly signed approval letter.
                  example: approval.pdf
                officialEmailID:
                  type: string
                  description: The official email ID that has to be configured for the API Auth token.
                  enum:
                  - 'Yes'
                  - 'No'
                  example: abc@example.com
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  aggregatorID:
                    type: string
                    description: The unique identifier of the created aggregator.
                    example: Volopay
      tags:
      - Aggregator
      summary: Create aggregator
      x-summary-source: derived
      operationId: postAggregator
      x-operation-id-source: derived
    servers:
    - url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
  /aggregator/{aggregatorId}:
    get:
      security:
      - bearerAuth: []
      summary: View a List of Enterprises
      description: Use this endpoint to fetch a list of all the enterprises onboarded by an aggregator.
      operationId: view-enterprise-list
      parameters:
      - name: aggregatorId
        in: path
        required: true
        schema:
          type: string
          description: Unique identifier of the aggregator.
      - name: x-tenant-id
        in: header
        required: true
        schema:
          type: string
          example: falcon
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          example: Bearer {{access_token}}
      responses:
        '200':
          description: Enterprises fetched successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  aggregatorID:
                    type: string
                    example: agg_001
                    description: The unique ID of an aggregator.
                  aggregatorName:
                    type: string
                    example: Kite Aggregator Services
                    description: The name of the aggregator.
                  aggregatorType:
                    type: string
                    example: Fintech
                    description: The type of the aggregator. Below are the possible values.
                    enum:
                    - Corporate
                    - Fintech
                    - Business
                  enterpriseDetails:
                    type: object
                    description: Details of the onboarded enterprise.
                    properties:
                      enterpriseID:
                        type: string
                        example: ent_001
                        description: The unique ID of the enterprise.
                      enterpriseName:
                        type: string
                        example: Falcon Enterprises Pvt. Ltd.
                        description: The name of the enterprise.
                      enterpriseType:
                        type: string
                        example: SME
                        description: The type of the enterprise.
        '401':
          description: Unauthorized access
        '500':
          description: Internal server error
      tags:
      - Aggregator
    servers:
    - url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-refined-from:
- falcon-add-an-aggregator-openapi.yml
- falcon-view-a-list-of-enterprises-openapi.yml
x-provenance:
  method: searched
  source: https://docs.falconfs.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.falconfs.com/reference/add-program.md
  merge:
    pages: 1
    deduped: 0
    conflicts_kept_first: 0