# Search Transactions

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/merchant-virtual-account/transactions/search:
    post:
      summary: Search Transactions
      deprecated: false
      description: >-
        Use this API to search and retrieve transactions associated with virtual
        accounts. Filter results by transaction ID, status, payment mode, amount
        range, date ranges, settlement status, and more. The product code is
        automatically scoped to VIRTUAL_ACCOUNT. Supports pagination to control
        the number of records returned.
      tags:
        - Payment Gateway/APIs - Payment Gateway /E-Collect
      parameters:
        - name: offset
          in: query
          description: |
            Page offset
          required: false
          example: 0
          schema:
            type: integer
        - name: limit
          in: query
          description: |
            Records per page
          required: false
          example: 5000
          schema:
            type: integer
        - name: orderBy
          in: query
          description: |
            Sort field
          required: false
          example: id
          schema:
            type: string
        - name: direction
          in: query
          description: |
            Sort direction (ASC/DESC)
          required: false
          example: DESC
          schema:
            type: string
        - name: Authorization
          in: header
          description: Token generated with your Access key and secret key
          required: true
          example: Bearer jIR6lhjFvimVkjNUMEhPWpsnCiI
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                transactionIds:
                  type: array
                  items:
                    type: string
                amountFrom:
                  type: number
                amountTo:
                  type: number
                status:
                  type: string
                settlementStatus:
                  type: string
                type:
                  type: string
                bankTransactionId:
                  type: string
                paymentMode:
                  type: string
                customerEmail:
                  type: string
                customerPhone:
                  type: string
                txnDateFrom:
                  type: string
                txnDateTo:
                  type: string
              x-apidog-orders:
                - transactionIds
                - amountFrom
                - amountTo
                - status
                - settlementStatus
                - type
                - bankTransactionId
                - paymentMode
                - customerEmail
                - customerPhone
                - txnDateFrom
                - txnDateTo
            example:
              transactionIds:
                - string
              amountFrom: 0.01
              amountTo: 0.01
              status: CREATED
              settlementStatus: PENDING
              type: SALE
              bankTransactionId: string
              paymentMode: NET_BANKING
              customerEmail: string
              customerPhone: string
              txnDateFrom: '2026-05-01 10:30:00'
              txnDateTo: '2026-05-01 10:30:00'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_code:
                    type: integer
                    description: Application-level status code
                  response_message:
                    type: string
                    description: High-level status description.
                  payload:
                    type: object
                    properties:
                      recordsCount:
                        type: integer
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            transactionId:
                              type: string
                            created:
                              type: string
                            lastModified:
                              type: string
                            orderId:
                              type: string
                            merchantUniqueId:
                              type: integer
                            merchantOrderId:
                              type: string
                            merchantIdentifierKey:
                              type: string
                            type:
                              type: string
                            finalAmount:
                              type: integer
                            surcharge:
                              type: integer
                            surchargeGst:
                              type: integer
                            amount:
                              type: integer
                            currency:
                              type: string
                            returnUrl:
                              type: string
                            notifyUrl:
                              type: string
                            status:
                              type: string
                            requestSource:
                              type: string
                            customerInfo:
                              type: object
                              properties:
                                firstName:
                                  type: string
                                phoneNumber:
                                  type: string
                                email:
                                  type: string
                              required:
                                - firstName
                                - phoneNumber
                                - email
                              x-apidog-orders:
                                - firstName
                                - phoneNumber
                                - email
                            paymentDetailBean:
                              type: object
                              properties:
                                paymentMode:
                                  type: string
                                bankName:
                                  type: string
                                cardScheme:
                                  type: 'null'
                                accountNumber:
                                  type: string
                                ifsc:
                                  type: string
                              required:
                                - paymentMode
                                - bankName
                                - cardScheme
                                - accountNumber
                                - ifsc
                              x-apidog-orders:
                                - paymentMode
                                - bankName
                                - cardScheme
                                - accountNumber
                                - ifsc
                            bankResponse:
                              type: object
                              properties:
                                bankTransactionId:
                                  type: string
                              required:
                                - bankTransactionId
                              x-apidog-orders:
                                - bankTransactionId
                            invoices:
                              type: array
                              items:
                                type: string
                            consentTransaction:
                              type: boolean
                            txnMessage:
                              type: 'null'
                            bankCard:
                              type: boolean
                            txnDate:
                              type: string
                            linkedTransactions:
                              type: array
                              items:
                                type: string
                            settlementTransaction:
                              type: object
                              properties:
                                settlementTransactionId:
                                  type: string
                                charges:
                                  type: integer
                                taxAmount:
                                  type: number
                                settlementAmount:
                                  type: number
                                settlementStatus:
                                  type: string
                              required:
                                - settlementTransactionId
                                - charges
                                - taxAmount
                                - settlementAmount
                                - settlementStatus
                              x-apidog-orders:
                                - settlementTransactionId
                                - charges
                                - taxAmount
                                - settlementAmount
                                - settlementStatus
                            settlementPayout:
                              type: object
                              properties:
                                payoutStatus:
                                  type: string
                                payoutDate:
                                  type: string
                                utr:
                                  type: string
                              required:
                                - payoutStatus
                                - payoutDate
                                - utr
                              x-apidog-orders:
                                - payoutStatus
                                - payoutDate
                                - utr
                            parentTransactionId:
                              type: 'null'
                            merchantName:
                              type: string
                            productId:
                              type: string
                            productCode:
                              type: string
                            pgPartnerTransactionId:
                              type: string
                          x-apidog-orders:
                            - transactionId
                            - created
                            - lastModified
                            - orderId
                            - merchantUniqueId
                            - merchantOrderId
                            - merchantIdentifierKey
                            - type
                            - finalAmount
                            - surcharge
                            - surchargeGst
                            - amount
                            - currency
                            - returnUrl
                            - notifyUrl
                            - status
                            - requestSource
                            - customerInfo
                            - paymentDetailBean
                            - bankResponse
                            - invoices
                            - consentTransaction
                            - txnMessage
                            - bankCard
                            - txnDate
                            - linkedTransactions
                            - settlementTransaction
                            - settlementPayout
                            - parentTransactionId
                            - merchantName
                            - productId
                            - productCode
                            - pgPartnerTransactionId
                    required:
                      - recordsCount
                      - data
                    x-apidog-orders:
                      - recordsCount
                      - data
                    description: Contains Virtual Account related response data.
                required:
                  - response_code
                  - response_message
                  - payload
                x-apidog-orders:
                  - response_code
                  - response_message
                  - payload
              example:
                response_code: 0
                response_message: SUCCESS
                payload:
                  recordsCount: 10
                  data:
                    - transactionId: txn_001
                      created: '2026-05-01 10:30:00'
                      lastModified: '2026-05-01 10:35:00'
                      orderId: ord_001
                      merchantUniqueId: 1001
                      merchantOrderId: ORD123
                      merchantIdentifierKey: mik_abc
                      type: SALE
                      finalAmount: 5000
                      surcharge: 50
                      surchargeGst: 9
                      amount: 5000
                      currency: INR
                      returnUrl: https://merchant.com/return
                      notifyUrl: https://merchant.com/notify
                      status: SUCCESS
                      requestSource: API
                      customerInfo:
                        firstName: John
                        phoneNumber: '9876543210'
                        email: john@example.com
                      paymentDetailBean:
                        paymentMode: UPI
                        bankName: RBL Bank
                        cardScheme: null
                        accountNumber: '9876543210123'
                        ifsc: SBIN0001234
                      bankResponse:
                        bankTransactionId: BANK123456
                      invoices: []
                      consentTransaction: false
                      txnMessage: null
                      bankCard: false
                      txnDate: '2026-05-01 10:30:00'
                      linkedTransactions: []
                      settlementTransaction:
                        settlementTransactionId: stxn_001
                        charges: 25
                        taxAmount: 4.5
                        settlementAmount: 4970.5
                        settlementStatus: APPROVED
                      settlementPayout:
                        payoutStatus: PAID
                        payoutDate: '2026-05-03 12:00:00'
                        utr: UTR123456789
                      parentTransactionId: null
                      merchantName: Test Merchant
                      productId: prod_001
                      productCode: VIRTUAL_ACCOUNT
                      pgPartnerTransactionId: PG_TXN_001
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Payment Gateway/APIs - Payment Gateway /E-Collect
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-36591636-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```
