List Payments

Retrieve a list of payments for a merchant.

GET /pg/payments

Try it

List Payments

cURL

curl --request GET \
  --url https://api-staging.eximpe.com/pg/payments/ \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'

200

{
  "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": "[e-mail]",
          "phone": "[phone]"
        },
        "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"
      }
    ]
  }
}

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

Authorizations

X-Client-ID · string · header · required

Client app ID. You can find your app id in the merchant dashboard.

X-Client-Secret · string · header · required

Client secret key. You can find your secret in the merchant dashboard.

Query Parameters

currency · string

Filter by 3-letter ISO currency code.

merchant_id · string

Filter by merchant ID.

payment_id · string

Filter by payment ID.

reference_id · string

Filter by order reference ID.

buyer_name · string

Filter by buyer's name.

mop_type · enum<string>

Filter by payment mode.

Available options: UPI, CREDIT_CARD, DEBIT_CARD, NET_BANKING, QR

status · enum<string>

Filter by payment status.

Available options: PENDING, CAPTURED, FAILED

from_created_date · string<date>

Filter by creation date (from).

to_created_date · string<date>

Filter by creation date (to).

Response

200

application/json

A paginated list of payments.

success · boolean · required

Indicates if the request was successful

message · string · required

Response message

data · object · required

Show child attributes

data. count · integer · required

Total number of payments

data. page · integer · required

Current page number

data. page_size · integer · required

Number of payments per page

data. next · string | null · required

URL for the next page of results

data. previous · string | null · required

URL for the previous page of results

data. results · object[] · required

Show child attributes

data.results. payment_id · string · required

Unique payment request identifier

data.results. merchant · object · required

Show child attributes

data.results.merchant. id · string · required

Merchant ID

data.results.merchant. name · string · required

Merchant name

data.results. reference_id · string · required

Order reference identifier

data.results. buyer · object · required

Show child attributes

data.results.buyer. name · string · required

Buyer's full name

data.results.buyer. email · string<email> · required

Buyer's email address

data.results.buyer. phone · string · required

Buyer's phone number with country code

data.results. amount · object · required

Show child attributes

data.results.amount. amount · string · required

Payment amount

data.results.amount. total_amount · string · required

Total payment amount

data.results.amount. currency · string · required

3-letter ISO currency code

data.results. created_at · string<date-time> · required

Payment creation timestamp

data.results. mop_type · enum<string> · required

Method of payment

Available options: UPI, CREDIT_CARD, DEBIT_CARD, NET_BANKING, QR

data.results. status · enum<string> · required

Payment status

Available options: PENDING, CAPTURED, FAILED

data.results. comment · string | null

Additional comment or status message