Falcon Banking API

openapi: 3.2.0
info:
  title: Repayment Banking API
  description: API endpoints for credit card repayments, including bill payments, reversals, auto-debit configurations, and payment status checks.
  version: 1.0.0
servers:
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1
tags:
- name: Banking
paths:
  /banking/payment/PHONEPE/options:
    get:
      security:
      - bearerAuth: []
      summary: Fetch Payment Options
      description: Use this endpoint to fetch all the payment modes available for the payment.
      operationId: fetch-payment-options
      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: enterpriseId
        in: header
        required: true
        schema:
          type: string
          description: The ID of the enterprise for the payment options.
          example: b3488889-5a07-48d5-99b4-fa963fdfbb02
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  upiCollect:
                    type: boolean
                    description: Indicates if UPI collect is available.
                    example: true
                    enum:
                    - true
                    - false
                  upiScanPay:
                    type: boolean
                    description: Indicates if UPI scan and pay is available.
                    example: true
                    enum:
                    - true
                    - false
                  netBanking:
                    type: boolean
                    description: Indicates if net banking is available.
                    example: true
                    enum:
                    - true
                    - false
                  popularBanks:
                    type: array
                    description: List of popular banks available for payment.
                    items:
                      type: object
                      properties:
                        bankId:
                          type: string
                          description: The ID of the bank.
                          example: HDFC
                        bankName:
                          type: string
                          description: The name of the bank.
                          example: Hdfc Bank
                        bankShortName:
                          type: string
                          description: The short name of the bank.
                          example: 'null'
                        bankLogo:
                          type: string
                          description: The logo of the bank.
                          example: https://img.phonepe.com/images/banks/40/40/HDFC.png
                example:
                  upiCollect: true
                  upiScanPay: true
                  netBanking: true
                  popularBanks:
                  - bankId: HDFC
                    bankName: Hdfc Bank
                    bankShortName: 'null'
                    bankLogo: https://img.phonepe.com/images/banks/40/40/HDFC.png
                  - bankId: SBIN
                    bankName: State bank Of India
                    bankShortName: SBI
                    bankLogo: https://img.phonepe.com/images/banks/40/40/SBIN.png
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized request
      tags:
      - Banking
  /banking/payment/PHONEPE/validate/vpa:
    post:
      security:
      - bearerAuth: []
      summary: Validate Virtual Payment Address
      description: Use this endpoint to validate the virtual payment address entered by the user.
      operationId: validate-vpa
      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: enterpriseId
        in: header
        required: true
        schema:
          type: string
          description: The ID of the enterprise.
          example: b3488889-5a07-48d5-99b4-fa963fdfbb02
      - name: userId
        in: header
        required: true
        schema:
          type: string
          description: The ID of the user.
          example: b3488889-5a07-48d5-99b4-fa963fdfbb02
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - vpa
              properties:
                vpa:
                  type: string
                  description: The virtual payment address to validate.
                  example: abc08@ybl
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: The status of the validation.
                    example: SUCCESS
                    enum:
                    - SUCCESS
                    - FAILURE
                  message:
                    type: string
                    description: The message for the validation status.
                    example: Your request has been successfully completed.
                  name:
                    type: string
                    description: The name of the user associated with the VPA.
                    example: ABC
                  vpa:
                    type: string
                    description: The validated virtual payment address.
                    example: abc08@ybl
        '400':
          description: Invalid request parameters
        '401':
          description: Unauthorized request
      tags:
      - Banking
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/fetch-payment-options.md
  - https://docs.falconfs.com/reference/fetch-payment-status.md
  - https://docs.falconfs.com/reference/get-all-repayments.md
  - https://docs.falconfs.com/reference/post-repayment.md
  - https://docs.falconfs.com/reference/repay-user-account.md
  - https://docs.falconfs.com/reference/repayment-via-netbanking.md
  - https://docs.falconfs.com/reference/repayment-via-pg.md
  - https://docs.falconfs.com/reference/reverse-repayment-transaction.md
  - https://docs.falconfs.com/reference/set-auto-debit-configuration-enterprise.md
  - https://docs.falconfs.com/reference/set-auto-debit-configuration.md
  - https://docs.falconfs.com/reference/validate-vpa.md
  - https://docs.falconfs.com/reference/view-enterprise-auto-debit-configuration.md
  - https://docs.falconfs.com/reference/view-user-auto-debit-configuration.md
  merge:
    pages: 13
    deduped: 0
    conflicts_kept_first: 0