openapi: 3.2.0
info:
  title: Falcon Enterprise API
  version: 1.0.0
  description: 'Operations tagged Enterprise across 6 of this provider''s published API definitions: falcon-add-an-enterprise-admin-openapi.yml, falcon-block-or-allow-mccs-for-enterprise-openapi.yml, falcon-onboard-an-enterprise-openapi.yml, falcon-repayment-apis-openapi.yml, falcon-update-enterprise-credit-limits-openapi.yml, falcon-update-enterprise-details-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
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1/
- url: https://stage1.tab.kitecash.in/open-api/falcon/v1
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1/enterprise
tags:
- name: Enterprise
paths:
  /enterprise:
    post:
      summary: Add an Enterprise Admin
      description: Use this endpoint to add administrator for a particular enterprise.
      operationId: add-enterprise-admin
      parameters:
      - 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}}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - enterpriseID
              - adminFullName
              - adminContactNumber
              - adminEmail
              $ref: '#/components/schemas/AddCorporateAdminRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCorporateAdminResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Enterprise
    put:
      summary: Update Enterprise Details
      description: 'Use this endpoint to update the following details of an existing enterprise (corporate):

        - Name

        - Registered Name

        - Mobile number

        - Email

        - GSTIN

        - Address

        - Website

        - Director details


        **Note:**

        All checks about validating the new mobile number, email or address (and any other proofs like FIR, etc.) for lost SIM are done by the bank and updated in the core banking solution (CBS) before updating in cash management services (CMS).


        You should only pass those values that need to be updated. You cannot update the Identifier type and value parameters, they need to be taken as an input so as to identify a specific enterprise you are trying to update.'
      operationId: updateEnterprise
      parameters:
      - 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}}
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - identifierType
              - identifierValue
              - name
              - registeredName
              - mobile
              - directors[0].name
              - directors[0].pan
              - directors[0].mobile
              $ref: '#/components/schemas/EnterpriseUpdateRequest'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnterpriseResponse_2'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Internal server error
      tags:
      - Enterprise
    servers:
    - url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
  /enterprise/account/auto-debit:
    post:
      security:
      - bearerAuth: []
      summary: Set or Change Auto-Debit Configuration of an Enterprise Account
      description: Use this endpoint to set a configuration of auto-pay/ standing instruction for an enterprise account.
      operationId: set-auto-debit-configuration-enterprise
      parameters:
      - 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}}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enterpriseid
              - programid
              - amountConfig
              - bank
              properties:
                enterpriseid:
                  type: string
                  description: The ID of the enterprise for the auto-debit configuration.
                  example: b3488889-5a07-48d5-99b4-fa963fdfbb02
                programid:
                  type: string
                  description: The ID of the program for the auto-debit configuration.
                  example: 123456yhtj
                amountConfig:
                  type: string
                  description: The configuration for the auto-debit amount.
                  example: MAD
                bank:
                  type: object
                  description: The bank details for the auto-debit configuration.
                  required:
                  - accountnumber
                  - Ifsc
                  properties:
                    accountnumber:
                      type: string
                      description: The account number for the auto-debit configuration.
                      example: '12345678901'
                    Ifsc:
                      type: string
                      description: The IFSC of the bank.
                      example: HDFC00000056
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized request
      tags:
      - Enterprise
    servers:
    - url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
  /enterprise/{enterpriseId}/auto-debit:
    get:
      security:
      - bearerAuth: []
      summary: View Enterprise Account Auto-Debit Configuration
      description: Use this endpoint to view configuration of auto-pay/ standing instruction of an enterprise account.
      operationId: view-enterprise-auto-debit-configuration
      parameters:
      - name: enterpriseId
        in: path
        required: true
        schema:
          type: string
        description: The ID of the enterprise for the auto-debit configuration.
        example: b3488889-5a07-48d5-99b4-fa963fdfbb02
      - 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: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  programID:
                    type: string
                    description: The ID of the program for the auto-debit configuration.
                    example: 123456yhtj
                  opt:
                    type: string
                    description: Indicates if auto-debit is enabled.
                    example: 'yes'
                    enum:
                    - 'yes'
                    - 'no'
                  amountConfig:
                    type: string
                    description: Amount configuration type.
                    example: MAD
                  bank:
                    type: object
                    description: Bank details for the auto-debit configuration.
                    properties:
                      accountnumber:
                        type: string
                        description: The bank account number.
                        example: '12345678901'
                      Ifsc:
                        type: string
                        description: The IFSC of the bank.
                        example: HDFC00000056
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized request
      tags:
      - Enterprise
    servers:
    - url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
components:
  schemas:
    AddCorporateAdminResponse:
      type: object
      properties:
        Message:
          type: string
          description: A message indicating the result of the operation.
          example: Corporate Administrator added successfully.
    AddCorporateAdminRequest:
      type: object
      properties:
        enterpriseID:
          type: string
          description: The ID of the enterprise for which the admin is being added.
          example: 1234567890
        adminFullName:
          type: string
          description: The full name of the administrator being added.
          example: Rachit Gupta
        adminContactNumber:
          type: string
          description: The contact number of the administrator being added.
          example: '9910010101'
        adminType:
          type: string
          description: The type of administrator being added.
          example: CORPORATE_ADMIN
        adminEmail:
          type: string
          description: The email address of the administrator being added.
          format: email
          example: rachiit@wework.com
    EnterpriseProgramActionRequest:
      type: object
      properties:
        enterpriseId:
          type: string
          description: The unique identifier for the enterprise.
          format: uuid
          example: 8a5364cd-e606-4328-8915-2bdf31c77ebe
        programeID:
          type: string
          description: The unique identifier for the program.
          example: SFCC02
        action:
          type: string
          description: An action to be taken on the MCC.
          enum:
          - allow
          - restrict
          example: allow
        mcc:
          type: string
          description: The merchant category code to be blocked or allowed.
          example: '5812'
    SuccessResponse:
      type: object
      description: Empty response for successful action
    EnterpriseRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the enterprise you want to add.
          example: FALCON
        registeredName:
          type: string
          description: The registered name of the enterprise.
          example: FALCON ENTERPRISES
        incorporationDate:
          type: string
          description: The date of incorporation of the enterprise.
          example: '2021-01-01T00:00:00.000Z'
        website:
          type: string
          description: The official website of the enterprise.
          example: https://www.falconfs.com/
        mobile:
          type: string
          description: The mobile number of the admin/POC of the enterprise.
          example: 9876543210
        email:
          type: string
          description: The email ID of the admin/POC of the enterprise.
          format: email
          example: abc@example.com
        classification:
          type: string
          description: The classification of the enterprise.
          example: MEDIUM
        industryType:
          type: string
          description: The industry type of the enterprise.
          example: MANUFACTURING
        legalConstitution:
          type: string
          description: The legal constitution of the enterprise.
          example: PRIVATE_LIMITED
        relatedType:
          type: string
          description: The related type of the enterprise.
          example: RESIDENT_INDIAN_INDIVIDUAL
        relationshipType:
          type: string
          description: The type of relationship of the admin/POC with the enterprise.
          example: HOLDING_COMPANY
        type:
          type: string
          description: The type of the enterprise.
          example: CORPORATE
        cif:
          type: string
          description: The CIF number of the enterprise.
          example: 123456789
        pan:
          type: string
          description: The PAN of the enterprise.
          example: ABCDE1234F
        cin:
          type: string
          description: The CIN of the enterprise.
          example: 223410000000000
        gstin:
          type: string
          description: The GSTIN of the enterprise.
          example: 33AAACT3373J1ZF
        addresses:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: The type of the address. Along with this address type, you should also add the communication address.
                example: REGISTERED
                enum:
                - REGISTERED
                - COMMUNICATION
              address:
                type: string
                description: The complete address of the enterprise.
                example: Wework, Blue 1 Sqaure
              city:
                type: string
                description: The city of the enterprise.
                example: Gurugram
              state:
                type: string
                description: The state of the enterprise.
                example: Haryana
              pinCode:
                type: string
                description: The pin code of the enterprise.
                example: 122001
              country:
                type: string
                description: The country of the enterprise.
                example: India
        programs:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the program.
                example: 1234567890
              dueDate:
                type: string
                description: The due date of the program.
                example: '2023-12-31T00:00:00.000Z'
              account:
                type: object
                properties:
                  accountNumber:
                    type: string
                    description: The account number of the enterprise.
                    example: 123456789012
                  branchName:
                    type: string
                    description: The branch name of the enterprise.
                    example: Main Branch
                  ifsc:
                    type: string
                    description: The IFSC of the enterprise.
                    example: ABCD0123456
              autoDebit:
                type: object
                properties:
                  status:
                    type: string
                    description: The status of auto debit.
                    example: 'YES'
                    enum:
                    - 'YES'
                    - 'NO'
                  type:
                    type: string
                    description: The type of auto debit.
                    example: MAD
              creditLimit:
                type: object
                properties:
                  max:
                    type: string
                    description: The maximum credit limit of the enterprise.
                    example: 1000000
                  current:
                    type: string
                    description: The current credit limit of the enterprise.
                    example: 500000
        directors:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: The name of the director.
                example: John Doe
              email:
                type: string
                description: The email ID of the director.
                example: john.doe@example.com
                format: email
    EnterpriseResponse:
      type: object
      properties:
        name:
          type: string
        enterpriseId:
          type: string
          description: The unique ID of the onboarded enterprise.
          format: uuid
    EnterpriseCreditLimitRequest:
      type: object
      properties:
        enterpriseId:
          type: string
          description: The unique identifier for the enterprise.
          format: uuid
          example: 8a5364cd-e606-4328-8915-2bdf31c77ebe
        programeID:
          type: string
          description: The unique identifier for the program.
          example: SFCC02
        creditLimit:
          type: object
          description: The credit limit details.
          properties:
            Max:
              type: integer
              description: The maximum credit limit for the enterprise.
              example: 5000000
            creditLimit:
              type: integer
              description: The credit limit amount.
              example: 20000
    EnterpriseUpdateRequest:
      type: object
      properties:
        identifierType:
          type: string
          description: The type of identifier used to identify the enterprise. This can be a PAN, GSTIN, or any other identifier.
          example: PAN
        identifierValue:
          type: string
          description: The value of the identifier used to identify the enterprise. This can be a PAN number, GSTIN number, or any other identifier.
          example: ABCDE1234F
        name:
          type: string
          description: The name of the enterprise.
          example: UBER
        registeredName:
          type: string
          description: The registered name of the enterprise.
          example: Alphabet LLC
        website:
          type: string
          description: The website of the enterprise.
          example: www.google.alphabet.co245
          format: uri
        mobile:
          type: string
          description: The mobile number of the admin/POC of the enterprise.
          example: 9876543210
        email:
          type: string
          description: The email address of the admin/POC of the enterprise.
          example: abc@example.com
          format: email
        gstin:
          type: string
          description: The GSTIN of the enterprise.
          example: 27ABCDE1234F1Z5
        directors:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: The name of the director.
                example: John Doe
              pan:
                type: string
                description: The PAN of the director.
                example: ABCDE1234F
              mobile:
                type: string
                description: The mobile number of the director.
                example: 9876543210
              email:
                type: string
                description: The email address of the director.
                example: john.doe@example.com
                format: email
    EnterpriseResponse_2:
      type: object
      properties:
        enterpriseId:
          type: string
          description: The unique identifier of the enterprise.
          example: 123e4567-e89b-12d3-a456-426614174000
          format: uuid
x-refined-from:
- falcon-add-an-enterprise-admin-openapi.yml
- falcon-block-or-allow-mccs-for-enterprise-openapi.yml
- falcon-onboard-an-enterprise-openapi.yml
- falcon-repayment-apis-openapi.yml
- falcon-update-enterprise-credit-limits-openapi.yml
- falcon-update-enterprise-details-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