# Search UPI QR

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/qr-code/search:
    post:
      summary: Search UPI QR
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to retrieve a list of UPI QR codes based on filters such as
        date range, status, or amount. This allows you to track multiple QR
        codes, monitor payment requests, and simplify reconciliation.

        :::
      tags:
        - Payment Gateway/APIs - Payment Gateway /UPI QR
      parameters:
        - name: offset
          in: query
          description: ''
          required: false
          schema:
            type: integer
        - name: limit
          in: query
          description: ''
          required: false
          schema:
            type: integer
            maximum: 5000
        - name: merchantAccessKey
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
        - name: Authorization
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QrCodeSearchRequest'
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                x-apidog-refs:
                  01J2110FW354SQGCP4DMVF6VRZ:
                    $ref: >-
                      #/components/schemas/ApplicationResponseGenericPaginationResponseQrCodeResponse
                    x-apidog-overrides: {}
                x-apidog-orders:
                  - 01J2110FW354SQGCP4DMVF6VRZ
                properties:
                  response_code:
                    type: integer
                    format: int32
                  response_message:
                    type: string
                  payload: &ref_0
                    $ref: >-
                      #/components/schemas/GenericPaginationResponseQrCodeResponse
                required:
                  - payload
                x-apidog-ignore-properties:
                  - response_code
                  - response_message
                  - payload
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /UPI QR
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-8990261-run
components:
  schemas:
    QrCodeSearchRequest:
      type: object
      properties:
        qrCodeId:
          type: string
          description: Unique QrCodeId provided by us
        qrCodeName:
          type: string
          description: qrCodeName
        amount:
          type: number
          description: amount
        status:
          type: string
          description: status
        referenceNumber:
          type: string
          description: referenceNumber
      x-apidog-orders:
        - qrCodeId
        - qrCodeName
        - amount
        - status
        - referenceNumber
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    GenericPaginationResponseQrCodeResponse:
      type: object
      properties:
        recordsCount:
          type: integer
          format: int64
        data:
          type: array
          items:
            $ref: '#/components/schemas/QrCodeResponse'
      x-apidog-orders:
        - recordsCount
        - data
      required:
        - recordsCount
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    QrCodeResponse:
      type: object
      properties:
        qrCodeId:
          type: string
          description: Unique QrCode Id generated at our end
        qrName:
          type: string
        multipleUse:
          type: boolean
        fixedAmount:
          type: boolean
        amount:
          type: number
        description:
          type: string
        expiry:
          type: string
        customParams:
          type: object
          properties:
            additionalProp1:
              type: string
            additionalProp2:
              type: string
            additionalProp3:
              type: string
          required:
            - additionalProp1
            - additionalProp2
            - additionalProp3
          x-apidog-orders:
            - additionalProp1
            - additionalProp2
            - additionalProp3
          x-apidog-ignore-properties: []
        status:
          type: string
          description: QrCode status
          enum:
            - ACTIVE
            - CANCELLED
          x-apidog-enum:
            - value: ACTIVE
              name: ''
              description: ''
            - value: CANCELLED
              name: ''
              description: ''
        qrCodeBase64:
          type: string
          description: Base64Image of the QrCode
        createdOn:
          type: string
          description: DateTime of the QrCode created
        modifiedOn:
          type: string
          description: DateTime of the QrCode modified
        customerName:
          type: string
        customerEmail:
          type: string
        customerMobile:
          type: string
        customerId:
          type: string
        referenceNumber:
          type: string
      x-apidog-orders:
        - qrCodeId
        - qrName
        - multipleUse
        - fixedAmount
        - amount
        - description
        - expiry
        - customParams
        - status
        - qrCodeBase64
        - createdOn
        - modifiedOn
        - customerName
        - customerEmail
        - customerMobile
        - customerId
        - referenceNumber
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    ApplicationResponseGenericPaginationResponseQrCodeResponse:
      type: object
      properties:
        response_code:
          type: integer
          format: int32
        response_message:
          type: string
        payload: *ref_0
      x-apidog-orders:
        - response_code
        - response_message
        - payload
      required:
        - payload
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```