Get Order

Get Order

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

import requests

url = "https://api-staging.eximpe.com/pg/orders/{order_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/orders/{order_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/orders/{order_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/orders/{order_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/orders/{order_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": "Order fetched successfully",
  "data": {
    "order_id": "OD9411897512",
    "reference_id": "TEST_FOB46D",
    "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": "BNYPG9212K",
      "dob": "2010-01-23"
    },
    "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"
    },
    "invoice": {
      "number": "IN1123213",
      "date": "2025-06-22",
      "file": "https://eximpe.com/inv-12312312.pdf"
    },
    "air_waybills": [
      {
        "number": "AWB-23343",
        "file": "https://eximpe.com/awb-8F3F51D2.pdf"
      },
      {
        "number": "IN1123213",
        "file": "https://eximpe.com/awb-12312312.pdf"
      }
    ],
    "payments": [
      {
        "payment_id": "PR1469384681",
        "mop_type": "UPI",
        "status": "captured",
        "status_message": null,
        "settlement": {
          "status": "ready_for_settlement",
          "message": null,
          "settlement_details": null
        },
        "created_at": "2025-06-23T10:44:14.344135Z"
      }
    ],
    "status": "payment_successful",
    "status_message": "Payment captured successfully",
    "created_at": "2025-06-23T10:44:11.702363Z",
    "is_testing": true
  }
}

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

{
  "success": false,
  "message": "Order not found",
  "error": {
    "code": "ERR_ORDER_404",
    "message": "Order with ID 'OD3451762252' not found"
  }
}

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

GET

orders

{order_id}

Get Order

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

import requests

url = "https://api-staging.eximpe.com/pg/orders/{order_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/orders/{order_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/orders/{order_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/orders/{order_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/orders/{order_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": "Order fetched successfully",
  "data": {
    "order_id": "OD9411897512",
    "reference_id": "TEST_FOB46D",
    "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": "BNYPG9212K",
      "dob": "2010-01-23"
    },
    "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"
    },
    "invoice": {
      "number": "IN1123213",
      "date": "2025-06-22",
      "file": "https://eximpe.com/inv-12312312.pdf"
    },
    "air_waybills": [
      {
        "number": "AWB-23343",
        "file": "https://eximpe.com/awb-8F3F51D2.pdf"
      },
      {
        "number": "IN1123213",
        "file": "https://eximpe.com/awb-12312312.pdf"
      }
    ],
    "payments": [
      {
        "payment_id": "PR1469384681",
        "mop_type": "UPI",
        "status": "captured",
        "status_message": null,
        "settlement": {
          "status": "ready_for_settlement",
          "message": null,
          "settlement_details": null
        },
        "created_at": "2025-06-23T10:44:14.344135Z"
      }
    ],
    "status": "payment_successful",
    "status_message": "Payment captured successfully",
    "created_at": "2025-06-23T10:44:11.702363Z",
    "is_testing": true
  }
}

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

{
  "success": false,
  "message": "Order not found",
  "error": {
    "code": "ERR_ORDER_404",
    "message": "Order with ID 'OD3451762252' not found"
  }
}

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

Overview

The Get Order endpoint allows you to retrieve complete order information including buyer details, product information, payment status, and timestamps. This is useful for order 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

order_id

string

required

Unique identifier of the order

Response

Order retrieved successfully

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

Overview

Authorizations

Path Parameters

Response