Get Payment

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

import requests

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

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/{payment_id}/', 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/{payment_id}/",
  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/{payment_id}/"

	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/{payment_id}/")

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 request details retrieved successfully",
  "data": {
    "payment_id": "PR3828502708",
    "order": {
      "order_id": "OD6530655496",
      "reference_id": "TEST_9P81ZL",
      "amount": 1000,
      "currency": "INR",
      "mop_type": "UPI",
      "buyer": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+919876543210",
        "address": {
          "line_1": "123 Main Street",
          "line_2": "Apt 4B",
          "city": "City",
          "state": "State",
          "postal_code": "123456"
        },
        "pan_number": "BNYPG1231L",
        "dob": "2025-06-19"
      },
      "product": {
        "name": "Sample Product",
        "description": "This is a sample product description",
        "hs_code": "98051000",
        "hs_code_description": "Portable automatic data processing machines",
        "type_of_goods": "goods"
      },
      "status": "payment_successful",
      "status_message": "Payment captured successfully",
      "created_at": "2025-06-19T09:17:56.338741Z"
    },
    "settlement": {
      "id": "ST4353980017",
      "settlement_id": "d42eda3f-41b6-4d82-add5-2665181f9eea",
      "settlement_completed_date": "2025-06-20T08:06:59.293548Z",
      "settlement_amount": 1000,
      "settlement_currency": "USD",
      "utr_number": "092dc30a-4f19-4318-9798-ad08b48801f6",
      "number_of_transactions": 1,
      "created_date": "2025-06-20T08:06:59.307056Z"
    },
    "refund": [
      {
        "refund_id": "RF8370660295",
        "refund_amount": 12,
        "refund_status": "INITIATED",
        "refunded_at": null,
        "message": "No action status found",
        "payment_id": "PR3828502708"
      }
    ],
    "collection_mode": "HOSTED_PAYMENT",
    "mop_type": "UPI",
    "bank_ref_num": "OD6530655496-PR3828502708",
    "mop_detail": {
      "upi_id": "pay@payu"
    },
    "payment_completed_at": "2025-06-19T14:48:11.000000Z",
    "status": "CAPTURED",
    "status_message": "Invoice and AWB file missing",
    "created_date": "2025-06-19T09:18:10.637579Z"
  }
}

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

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

GET

payments

{payment_id}

Get Payment

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

import requests

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

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/{payment_id}/', 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/{payment_id}/",
  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/{payment_id}/"

	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/{payment_id}/")

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 request details retrieved successfully",
  "data": {
    "payment_id": "PR3828502708",
    "order": {
      "order_id": "OD6530655496",
      "reference_id": "TEST_9P81ZL",
      "amount": 1000,
      "currency": "INR",
      "mop_type": "UPI",
      "buyer": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+919876543210",
        "address": {
          "line_1": "123 Main Street",
          "line_2": "Apt 4B",
          "city": "City",
          "state": "State",
          "postal_code": "123456"
        },
        "pan_number": "BNYPG1231L",
        "dob": "2025-06-19"
      },
      "product": {
        "name": "Sample Product",
        "description": "This is a sample product description",
        "hs_code": "98051000",
        "hs_code_description": "Portable automatic data processing machines",
        "type_of_goods": "goods"
      },
      "status": "payment_successful",
      "status_message": "Payment captured successfully",
      "created_at": "2025-06-19T09:17:56.338741Z"
    },
    "settlement": {
      "id": "ST4353980017",
      "settlement_id": "d42eda3f-41b6-4d82-add5-2665181f9eea",
      "settlement_completed_date": "2025-06-20T08:06:59.293548Z",
      "settlement_amount": 1000,
      "settlement_currency": "USD",
      "utr_number": "092dc30a-4f19-4318-9798-ad08b48801f6",
      "number_of_transactions": 1,
      "created_date": "2025-06-20T08:06:59.307056Z"
    },
    "refund": [
      {
        "refund_id": "RF8370660295",
        "refund_amount": 12,
        "refund_status": "INITIATED",
        "refunded_at": null,
        "message": "No action status found",
        "payment_id": "PR3828502708"
      }
    ],
    "collection_mode": "HOSTED_PAYMENT",
    "mop_type": "UPI",
    "bank_ref_num": "OD6530655496-PR3828502708",
    "mop_detail": {
      "upi_id": "pay@payu"
    },
    "payment_completed_at": "2025-06-19T14:48:11.000000Z",
    "status": "CAPTURED",
    "status_message": "Invoice and AWB file missing",
    "created_date": "2025-06-19T09:18:10.637579Z"
  }
}

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

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

Overview

The Get Payment endpoint allows you to retrieve complete payment information including order details, payment status, and transaction data. This is useful for payment tracking and status updates.

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.

Path Parameters

payment_id

string

required

The ID of the payment to retrieve.

Response

The details of the payment.

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

Get Payment

Overview

Authorizations

Path Parameters

Response