List Payments

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

import requests

url = "https://api-staging.eximpe.com/pg/payments/"

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Client-ID': '<api-key>', 'X-Client-Secret': '<api-key>'}
};

fetch('https://api-staging.eximpe.com/pg/payments/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.eximpe.com/pg/payments/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.eximpe.com/pg/payments/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.eximpe.com/pg/payments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
      }
    ]
  }
}

{
  "success": true,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

GET

payments

List Payments

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

import requests

url = "https://api-staging.eximpe.com/pg/payments/"

headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Client-ID': '<api-key>', 'X-Client-Secret': '<api-key>'}
};

fetch('https://api-staging.eximpe.com/pg/payments/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-staging.eximpe.com/pg/payments/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-staging.eximpe.com/pg/payments/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-staging.eximpe.com/pg/payments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
      }
    ]
  }
}

{
  "success": true,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

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

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

Order

Payment

Merchant

Settlement

Refund

Webhooks

List Payments

Overview

Filtering

Available Filters

Authorizations

Query Parameters

Response

​Overview

​Filtering

​Available Filters

Authorizations

Query Parameters

Response

Overview

Filtering

Available Filters