openapi: 3.2.0
info:
  title: Credit Card API
  description: APIs for managing credit cards, including issuance, activation, limits, and transactions.
  version: 1.0.0
servers:
- url: https://stage1.tab.kitecash.in/cc-open-api/falcon/v1/
tags:
- name: Card
paths:
  /card:
    get:
      summary: View Add-on Card Credit Limit
      description: Use this endpoint to view the spend limits of a linked add-on card.
      operationId: view-add-on-card-limit
      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}}
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  secondaryCardId:
                    type: string
                    description: The unique identifier of the add-on card.
                    example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
                  domestic:
                    type: object
                    description: Domestic transaction limit details.
                    properties:
                      online:
                        type: object
                        description: Online transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for online transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for online transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for online transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for online transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for online transactions.
                            example: 300
                      pos:
                        type: object
                        description: POS transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for POS transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for POS transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for POS transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for POS transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for POS transactions.
                            example: 300
                      atm:
                        type: object
                        description: ATM transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for ATM transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for ATM transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for ATM transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for ATM transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for ATM transactions.
                            example: 300
                      contactless:
                        type: object
                        description: Contactless transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for contactless transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for contactless transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for contactless transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for contactless transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for contactless transactions.
                            example: 300
                  international:
                    type: object
                    description: International transaction limit details.
                    properties:
                      online:
                        type: object
                        description: Online transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for online transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for online transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for online transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for online transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for online transactions.
                            example: 300
                      pos:
                        type: object
                        description: POS transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for POS transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for POS transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for POS transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for POS transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for POS transactions.
                            example: 300
                      atm:
                        type: object
                        description: ATM transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for ATM transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for ATM transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for ATM transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for ATM transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for ATM transactions.
                            example: 300
                      contactless:
                        type: object
                        description: Contactless transaction limit details.
                        properties:
                          perTransactionLimit:
                            type: integer
                            description: Per transaction limit for contactless transactions.
                            example: 1000
                          dailyTransactionAmount:
                            type: integer
                            description: Daily transaction amount limit for contactless transactions.
                            example: 2000
                          dailyTransactionCount:
                            type: integer
                            description: Daily transaction count limit for contactless transactions.
                            example: 10
                          monthlyTransactionAmount:
                            type: integer
                            description: Monthly transaction amount limit for contactless transactions.
                            example: 60000
                          monthlyTransactionCount:
                            type: integer
                            description: Monthly transaction count limit for contactless transactions.
                            example: 300
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/add-on:
    post:
      summary: Add an Add-on or Supplementary Card
      description: Use this endpoint to issue an add-on or a supplementary card (Virtual/Physical) to an active user.
      operationId: add-on-card
      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:
              - userId
              - accountId
              properties:
                userId:
                  type: string
                  description: The unique identifier of the user to whom the add-on card will be issued.
                  example: 83f1492f-d00a-4417-bfbf-7de7e13507f9
                accountId:
                  type: integer
                  description: The unique account ID to which the add-on card will be issued.
                  example: 202000004784
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  addOnCardId:
                    type: string
                    description: The unique identifier of the add-on card.
                    example: 83f1492f-d00a-4417-bfbf-7de7e13507f9
                  accountId:
                    type: integer
                    description: The unique account ID to which the add-on card is linked.
                    example: 202000004784
                  primaryCardId:
                    type: string
                    description: The unique identifier of the primary card to which the add-on card is linked.
                    example: 83f1492f-d00a-4417-bfbf-7de7e13507f9
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/card-details/{accountId}:
    get:
      summary: View List of Cards
      description: Retrieve a list of all cards linked to an account.
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: integer
        description: The unique account ID to which the cards are linked.
        example: 202000004782
      - 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:
                  accountId:
                    type: integer
                    description: The unique account ID to which the cards are linked.
                    example: 202000004782
                  programID:
                    type: string
                    description: The unique identifier of the card program.
                    example: SFC01
                  cardList:
                    type: array
                    description: List of cards linked to the account.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique identifier of the card.
                          example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
                        maskedCardNumber:
                          type: string
                          description: The masked card number for security.
                          example: 807470XXXXXX3967
                        cardHolderName:
                          type: string
                          description: The name of the cardholder.
                          example: SOMNATH TRIPATHI
                        cardStatus:
                          type: string
                          description: The status of the card.
                          example: ACTIVE
                          enum:
                          - ACTIVE
                          - BLOCKED
                          - INACTIVE
                          - EXPIRED
                  totalCount:
                    type: integer
                    description: The total number of cards associated with the account.
                    example: 1
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
      operationId: getCardCardDetailsByAccountId
      x-operation-id-source: derived
  /card/generate-otp:
    post:
      summary: Generate an OTP
      description: Use this endpoint to generate an OTP for setting a physical card PIN.
      operationId: generate-otp
      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:
              - cardId
              - reason
              properties:
                cardId:
                  type: string
                  description: The unique identifier of the card for which the OTP is being generated.
                  format: uuid
                  example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
                reason:
                  type: string
                  description: The reason for generating the OTP.
                  example: Set Card PIN
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  otp:
                    type: string
                    description: The generated OTP for setting the card PIN.
                    example: '123456'
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Card not found
      tags:
      - Card
  /card/policy:
    post:
      summary: Change Spend Limits
      description: Use this endpoint to update the spending limits of a card.
      operationId: change-spend-limits
      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:
              - cardId
              - domesticSpendLimits
              - internationalSpendLimits
              properties:
                cardId:
                  type: string
                  description: The unique identifier of the card.
                  example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
                  format: uuid
                domesticSpendLimits:
                  type: object
                  description: Domestic transaction limit details.
                  properties:
                    online:
                      $ref: '#/components/schemas/SpendLimits'
                    pos:
                      $ref: '#/components/schemas/SpendLimits'
                    atm:
                      $ref: '#/components/schemas/SpendLimits'
                    contactless:
                      $ref: '#/components/schemas/SpendLimits'
                internationalSpendLimits:
                  type: object
                  description: International transaction limit details.
                  properties:
                    online:
                      $ref: '#/components/schemas/SpendLimits'
                    pos:
                      $ref: '#/components/schemas/SpendLimits'
                    atm:
                      $ref: '#/components/schemas/SpendLimits'
                    contactless:
                      $ref: '#/components/schemas/SpendLimits'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/set-pin:
    post:
      summary: Set or Change Card PIN
      description: Use this endpoint to set a PIN for a physical card or change an existing PIN.
      operationId: set-pin
      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:
              - otp
              - encryptedPin
              - cardId
              properties:
                otp:
                  type: string
                  description: One-Time Password for authentication.
                  example: 194ac57f-8baf-41d8-9fae-7390698cf698
                encryptedPin:
                  type: string
                  description: Encrypted PIN to be set for the card.
                  example: B92CF4D17214CE2C7124EFB864BDF2B9F78CFAEF52FA39F235219E09AF9A4DB5
                cardId:
                  type: string
                  description: The unique identifier of the card for which the PIN is being set.
                  example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/{cardId}:
    post:
      summary: Enable or Disable a Card
      description: Use this endpoint enable or disable a card.
      operationId: enable-disable-card
      parameters:
      - name: cardId
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the non-PCI card.
        example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
      - 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:
              - usageStatus
              properties:
                usageStatus:
                  type: string
                  description: The status to set for the card.
                  example: ENABLED
                  enum:
                  - ENABLED
                  - DISABLED
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/{cardId}/channel:
    post:
      summary: Change Channel Statuses
      description: Use this endpoint to change the status of various channels.
      operationId: change-channel-statuses
      parameters:
      - name: cardId
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier for the card.
        example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
      - 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
              properties:
                domestic:
                  type: object
                  description: Domestic transaction status details.
                  properties:
                    online:
                      type: string
                      description: Online transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    pos:
                      type: string
                      description: POS transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    atm:
                      type: string
                      description: ATM transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    contactless:
                      type: string
                      description: Contactless transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                international:
                  type: object
                  description: International transaction status details.
                  properties:
                    online:
                      type: string
                      description: Online transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    pos:
                      type: string
                      description: POS transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    atm:
                      type: string
                      description: ATM transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
                    contactless:
                      type: string
                      description: Contactless transaction status.
                      example: 'ON'
                      enum:
                      - 'ON'
                      - 'OFF'
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                example: {}
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
  /card/{cardId}/policies/limits:
    get:
      summary: View Spend Limits
      description: Use the endpoint fetch the spending limits on a card.
      operationId: view-spend-limits
      parameters:
      - name: cardId
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the card.
        example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
      - name: x-tenant-id
        in: header
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  cardId:
                    type: string
                    description: The unique identifier of the card.
                    example: 9824c2dc-65ac-417a-a11c-43e47e8dfa6t
                  domestic:
                    type: object
                    description: Domestic transaction limit details.
                    properties:
                      online:
                        $ref: '#/components/schemas/TransactionLimits'
                      pos:
                        $ref: '#/components/schemas/TransactionLimits'
                      atm:
                        $ref: '#/components/schemas/TransactionLimits'
                      contactless:
                        $ref: '#/components/schemas/TransactionLimits'
                  international:
                    type: object
                    description: International transaction limit details.
                    properties:
                      online:
                        $ref: '#/components/schemas/TransactionLimits'
                      pos:
                        $ref: '#/components/schemas/TransactionLimits'
                      atm:
                        $ref: '#/components/schemas/TransactionLimits'
                      contactless:
                        $ref: '#/components/schemas/TransactionLimits'
        '400':
          description: Invalid request payload
        '401':
          description: Unauthorized access
        '404':
          description: Account not found
      tags:
      - Card
components:
  schemas:
    TransactionLimits:
      type: object
      properties:
        perTransactionLimit:
          type: integer
          description: Per transaction limit of the card.
          example: 1000
        dailyTransactionAmount:
          type: integer
          description: Daily transaction amount limit of the card.
          example: 2000
        dailyTransactionCount:
          type: integer
          description: Daily transaction count limit of the card.
          example: 10
        monthlyTransactionAmount:
          type: integer
          description: Monthly transaction amount limit of the card.
          example: 60000
        monthlyTransactionCount:
          type: integer
          description: Monthly transaction count limit of the card.
          example: 300
    SpendLimits:
      type: object
      properties:
        perTransactionLimit:
          type: integer
          description: Per transaction limit of the card.
          example: 1000
        dailyTransactionAmount:
          type: integer
          description: Daily transaction amount limit of the card.
          example: 2000
        dailyTransactionCount:
          type: integer
          description: Daily transaction count limit of the card.
          example: 10
        monthlyTransactionAmount:
          type: integer
          description: Monthly transaction amount limit of the card.
          example: 60000
        monthlyTransactionCount:
          type: integer
          description: Monthly transaction count limit of the card.
          example: 300
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/activate-card.md
  - https://docs.falconfs.com/reference/add-card.md
  - https://docs.falconfs.com/reference/add-on-card.md
  - https://docs.falconfs.com/reference/block-card.md
  - https://docs.falconfs.com/reference/change-channel-statuses.md
  - https://docs.falconfs.com/reference/change-spend-limits.md
  - https://docs.falconfs.com/reference/enable-disable-card.md
  - https://docs.falconfs.com/reference/generate-otp.md
  - https://docs.falconfs.com/reference/get_card-card-details-accountid.md
  - https://docs.falconfs.com/reference/replace-blocked-card.md
  - https://docs.falconfs.com/reference/set-pin.md
  - https://docs.falconfs.com/reference/validate-card-details.md
  - https://docs.falconfs.com/reference/view-add-on-card-limit.md
  - https://docs.falconfs.com/reference/view-card-cvv.md
  - https://docs.falconfs.com/reference/view-channel-status.md
  - https://docs.falconfs.com/reference/view-non-pci-card-details.md
  - https://docs.falconfs.com/reference/view-pci-card-details.md
  - https://docs.falconfs.com/reference/view-spend-limits.md
  merge:
    pages: 18
    deduped: 0
    conflicts_kept_first: 0