Skip to main content
GET
/
pg
/
payments
List Payments
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/pg/payments/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "success": true,
  "message": "Domestic payment requests retrieved successfully",
  "data": {
    "count": 15,
    "page": 1,
    "page_size": 10,
    "next": "https://api-pacb.eximpe.com/pg/payments/?page=2&page_size=10",
    "previous": null,
    "results": [
      {
        "payment_id": "PR2024120567891",
        "merchant": {
          "id": "3604346598",
          "name": "InnovateTech Solutions"
        },
        "reference_id": "ORD_IT_SERVICES_2024_1001",
        "buyer": {
          "name": "Kavya Nair",
          "email": "[email protected]",
          "phone": "+919876543201"
        },
        "order_id": "OD2024120567891",
        "invoice_number": "INV2024120567891",
        "amount": {
          "amount": "45000",
          "total_amount": "45000",
          "currency": "INR"
        },
        "created_at": "2024-12-05T15:22:18.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

  • payment_id
  • currency
  • merchant_id
  • order_id
  • reference_id
  • buyer_name
  • mop_type: (e.g., credit_card, debit_card, upi, net_banking, qr)
  • status: ( pending, captured, failed)
  • from_created_at / to_created_at

Authorizations

​
X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

​
X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

​
X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

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.

​
order_id
string

Filter by order 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_at
string<date>

Filter by creation date (from).

​
to_created_at
string<date>

Filter by creation date (to).

Response

A paginated list of payments.

​
success
boolean
required

Indicates if the request was successful

​
message
string
required

Response message

​
data
object
required