> ## Documentation Index
> Fetch the complete documentation index at: https://eximpe.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payments

> Retrieve a list of payments for a merchant.

## Overview

The List Payments endpoint allows you to search and retrieve payment records based on a variety of criteria. You can filter by payment status, date ranges, currency, and more. The response is paginated to handle large datasets efficiently.

## Filtering

You can combine multiple filters to create a precise query. All filter parameters are optional.

### Available Filters

* `currency`
* `merchant_id`
* `payment_id`
* `reference_id`
* `buyer_name`
* `mop_type`: (e.g., `CREDIT_CARD`, `DEBIT_CARD`, `UPI`, `NET_BANKING`, `QR`)
* `status`: ( `PENDING`, `CAPTURED`, `FAILED`)
* `from_created_date` / `to_created_date`


## OpenAPI

````yaml openapi.json get /pg/payments/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api-staging.eximpe.com
    description: Staging server
  - url: https://api.eximpe.com
    description: Production server
security:
  - clientAuth: []
    clientSecretAuth: []
paths:
  /pg/payments/:
    get:
      tags:
        - Payments
      summary: List Payments
      description: Retrieve a list of payments with optional filtering.
      parameters:
        - name: currency
          in: query
          description: Filter by 3-letter ISO currency code.
          schema:
            type: string
        - name: merchant_id
          in: query
          description: Filter by merchant ID.
          schema:
            type: string
        - name: payment_id
          in: query
          description: Filter by payment ID.
          schema:
            type: string
        - name: reference_id
          in: query
          description: Filter by order reference ID.
          schema:
            type: string
        - name: buyer_name
          in: query
          description: Filter by buyer's name.
          schema:
            type: string
        - name: mop_type
          in: query
          description: Filter by payment mode.
          schema:
            type: string
            enum:
              - UPI
              - CREDIT_CARD
              - DEBIT_CARD
              - NET_BANKING
              - QR
        - name: status
          in: query
          description: Filter by payment status.
          schema:
            type: string
            enum:
              - PENDING
              - CAPTURED
              - FAILED
        - name: from_created_date
          in: query
          description: Filter by creation date (from).
          schema:
            type: string
            format: date
        - name: to_created_date
          in: query
          description: Filter by creation date (to).
          schema:
            type: string
            format: date
      responses:
        '200':
          description: A paginated list of payments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponse'
              example:
                success: true
                message: Domestic payment requests retrieved successfully
                data:
                  count: 15
                  page: 1
                  page_size: 10
                  next: https://api.eximpe.com/pg/payments/?page=2&page_size=10
                  previous: null
                  results:
                    - id: PR1469384681
                      merchant:
                        id: '4455704961'
                        name: Acme Corp
                      reference_id: ACME_ORD_1001
                      buyer:
                        name: Rahul Mehta
                        email: rahul.mehta@acme.com
                        phone: '+919812345678'
                      payment_id: OD9411897512
                      amount:
                        amount: '1000'
                        total_amount: '1000'
                        currency: INR
                      created_at: '2025-06-23T10:44:14.344135Z'
                      comment: null
                      mop_type: UPI
                      status: CAPTURED
        '401':
          description: Unauthorized - Invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
components:
  schemas:
    ListPaymentsResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        message:
          type: string
          description: Response message
        data:
          type: object
          required:
            - count
            - page
            - page_size
            - next
            - previous
            - results
          properties:
            count:
              type: integer
              description: Total number of payments
            page:
              type: integer
              description: Current page number
            page_size:
              type: integer
              description: Number of payments per page
            next:
              type: string
              nullable: true
              description: URL for the next page of results
            previous:
              type: string
              nullable: true
              description: URL for the previous page of results
            results:
              type: array
              items:
                $ref: '#/components/schemas/PaymentInList'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        error:
          $ref: '#/components/schemas/ErrorDetails'
    PaymentInList:
      type: object
      required:
        - id
        - merchant
        - reference_id
        - buyer
        - payment_id
        - amount
        - created_at
        - mop_type
        - status
      properties:
        payment_id:
          type: string
          description: Unique payment request identifier
        merchant:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
              description: Merchant ID
            name:
              type: string
              description: Merchant name
        reference_id:
          type: string
          description: Order reference identifier
        buyer:
          type: object
          required:
            - name
            - email
            - phone
          properties:
            name:
              type: string
              description: Buyer's full name
            email:
              type: string
              format: email
              description: Buyer's email address
            phone:
              type: string
              description: Buyer's phone number with country code
        amount:
          type: object
          required:
            - amount
            - total_amount
            - currency
          properties:
            amount:
              type: string
              description: Payment amount
            total_amount:
              type: string
              description: Total payment amount
            currency:
              type: string
              description: 3-letter ISO currency code
        created_at:
          type: string
          format: date-time
          description: Payment creation timestamp
        comment:
          type: string
          nullable: true
          description: Additional comment or status message
        mop_type:
          type: string
          description: Method of payment
          enum:
            - UPI
            - CREDIT_CARD
            - DEBIT_CARD
            - NET_BANKING
            - QR
        status:
          type: string
          description: Payment status
          enum:
            - PENDING
            - CAPTURED
            - FAILED
    ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code (e.g., ERR_ORDER_002)
        message:
          type: string
          description: Error message
        details:
          type: object
          description: Detailed validation error information with field-specific errors
          additionalProperties:
            type: string
            description: Error message for the specific field
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: Client app ID. You can find your app id in the merchant dashboard.
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: Client secret key. You can find your secret in the merchant dashboard.

````