Falcon Emi Plan API

openapi: 3.2.0
info:
  title: Emi Plan API
  description: APIs for managing EMI plans and transactions
  version: 1.0.0
servers:
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
tags:
- name: Emi Plan
paths:
  /emi-plan/{issuerID}:
    get:
      security:
      - bearerAuth: []
      summary: View an EMI Plan Using a program ID
      description: Use this endpoint to view an EMI plan using a program ID.
      operationId: get-emi-plan
      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}}
      - name: issuerID
        in: path
        required: true
        schema:
          type: string
          description: The ID of the issuer to which the EMI plan belongs.
          example: issuerID123
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - status
              properties:
                status:
                  type: string
                  description: Status of the EMI plan.
                  example: Active
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  EmiplanID:
                    type: string
                    description: ID of the EMI plan.
                    example: emiPlanID123
                  StartDate:
                    type: string
                    description: Start date of the EMI plan in YYYY-MM-DD format.
                    example: '2023-01-01'
                  EndDate:
                    type: string
                    description: End date of the EMI plan in YYYY-MM-DD format.
                    example: '2023-12-31'
                  Status:
                    type: string
                    description: Status of the EMI plan.
                    example: active
                    enum:
                    - active
                    - inactive
                  ProgramID:
                    type: string
                    description: The ID of the program to which the EMI plan belongs.
                    example: programID123
                  Description:
                    type: string
                    description: Description of the EMI plan.
                    example: a small description about EMI plan
                  EmiCalculationType:
                    type: string
                    description: Type of EMI calculation.
                    example: monthly
                  TransactionEligibility:
                    type: object
                    description: Transaction eligibility criteria for the EMI plan.
                    properties:
                      TransactionCountAllowedPerRequest:
                        type: integer
                        description: Maximum number of transactions allowed per request.
                        example: 1
                      AllowedTransactionAge:
                        type: integer
                        description: Maximum age of transactions allowed for EMI.
                        example: 30
                      AllowBilledTransaction:
                        type: boolean
                        description: Whether billed transactions are allowed.
                        example: false
                        enum:
                        - true
                        - false
                      TransactionCategory:
                        type: array
                        items:
                          type: object
                          description: List of transaction categories allowed for EMI.
                          properties:
                            CategoryName:
                              type: string
                              description: Name of the transaction category.
                              example: fuel_transaction
                            Rules:
                              type: array
                              items:
                                type: object
                                description: Rules for the transaction category.
                                properties:
                                  Key:
                                    type: string
                                    description: Key for the rule.
                                    example: merchant_category_code
                                  Comparison:
                                    type: string
                                    description: Comparison operator for the rule.
                                    example: contains
                                  Value:
                                    type: array
                                    items:
                                      type: integer
                                      description: Values for the rule.
                                      example:
                                      - 5541
                                      - 5542
                                  Action:
                                    type: string
                                    description: Action to take if the rule is met.
                                    example: block
                  ProcessingFee:
                    type: object
                    description: Processing fee details for the EMI plan.
                    properties:
                      Type:
                        type: string
                        description: Type of processing fee.
                        example: PercentageWithMinAndMax
                      Percentage:
                        type: number
                        description: Percentage of the processing fee.
                        example: 16
                      MinAmount:
                        type: number
                        description: Minimum amount for the processing fee.
                        example: 100
                      MaxAmount:
                        type: number
                        description: Maximum amount for the processing fee.
                        example: 2000
                  EmiSchedulesRules:
                    type: array
                    items:
                      type: object
                      description: Rules for EMI schedules.
                      properties:
                        Month:
                          type: integer
                          description: Month number for the EMI schedule.
                          example: 3
                        Interest:
                          type: number
                          description: Interest rate for the EMI schedule.
                          example: 16
                        MinAmount:
                          type: number
                          description: Minimum amount for the EMI schedule.
                          example: 2500
                        MaxAmount:
                          type: number
                          description: Maximum amount for the EMI schedule.
                          example: 3000
                  Foreclosure:
                    type: object
                    description: Foreclosure details for the EMI plan.
                    properties:
                      Allowed:
                        type: boolean
                        description: Whether foreclosure is allowed.
                        example: true
                      RemoveForeclosureMonthInterest:
                        type: boolean
                        description: Whether to remove foreclosure month interest.
                        example: false
                      ForeclosureInterestCalculationType:
                        type: string
                        description: Type of foreclosure interest calculation.
                        example: monthly
                      ForeclosureCharges:
                        type: object
                        description: Foreclosure charges details.
                        properties:
                          Type:
                            type: string
                            description: Type of foreclosure charges.
                            example: PercentageWithMinAndMax
                          Percentage:
                            type: number
                            description: Percentage of the foreclosure charges.
                            example: 16
                          MinAmount:
                            type: number
                            description: Minimum amount for the foreclosure charges.
                            example: 100
                          MaxAmount:
                            type: number
                            description: Maximum amount for the foreclosure charges.
                            example: 2000
                  CoolingDays:
                    type: integer
                    description: Number of cooling days for the EMI plan.
                    example: 15
                  RefundProcessingFeeDays:
                    type: integer
                    description: Number of days for refund processing fee.
                    example: 45
                  forceClosureDpdDays:
                    type: integer
                    description: Number of days for force closure DPD.
                    example: 60
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      tags:
      - Emi Plan
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-emi-plan.md
  - https://docs.falconfs.com/reference/convert-outstanding-balance.md
  - https://docs.falconfs.com/reference/convert-transactions-emi.md
  - https://docs.falconfs.com/reference/foreclose-emi.md
  - https://docs.falconfs.com/reference/foreclosure-quote.md
  - https://docs.falconfs.com/reference/put_update-status-emi-plan.md
  - https://docs.falconfs.com/reference/view-amortisation-schedule.md
  - https://docs.falconfs.com/reference/view-emi-details.md
  - https://docs.falconfs.com/reference/view-emi-list.md
  - https://docs.falconfs.com/reference/view-emi-plan.md
  - https://docs.falconfs.com/reference/view-transaction-eligibility.md
  merge:
    pages: 11
    deduped: 0
    conflicts_kept_first: 0