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>'

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

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>'

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

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

data.payment_id

string

required

Unique payment request identifier

data.order

object

required

Show child attributes

data.order.order_id

string

required

Unique order identifier

data.order.reference_id

string

required

Order reference identifier

data.order.amount

number<float>

required

Order amount

data.order.currency

string

required

3-letter ISO currency code

data.order.status

enum<string>

required

Order status

Available options:

PAYMENT_PENDING,

PAYMENT_SUCCESSFUL,

FAILED

data.order.created_at

string<date-time>

required

Order creation timestamp

data.order.mop_type

enum<string>

Method of payment type

Available options:

UPI,

CREDIT_CARD,

NETBANKING,

DEBIT_CARD,

QR

data.order.buyer

object

Show child attributes

data.order.buyer.name

string

required

Buyer's full name

data.order.buyer.address

object

required

Show child attributes

data.order.buyer.address.line_1

string

required

Address line 1

data.order.buyer.address.city

string

required

City name

data.order.buyer.address.state

string

required

State name

data.order.buyer.address.postal_code

string

required

Postal/ZIP code

data.order.buyer.address.line_2

string

Address line 2

data.order.buyer.email

string<email>

Buyer's email address

data.order.buyer.phone

string

Buyer's phone number with country code

data.order.buyer.pan_number

string | null

Buyer's PAN number

data.order.buyer.dob

string<date> | null

Buyer's date of birth

data.order.product

object

Show child attributes

data.order.product.name

string

required

Product name

data.order.product.type_of_goods

enum<string>

required

Type of goods (e.g., goods)

Available options:

goods,

services

data.order.product.description

string

Product description

data.order.product.hs_code

string

Harmonized System code

data.order.product.hs_code_description

string

Description of the HS code

data.order.status_message

string | null

Order status message

data.settlement

object

required

Show child attributes

data.settlement.id

string

Settlement ID

data.settlement.settlement_id

string

Unique settlement identifier

data.settlement.settlement_completed_date

string<date-time>

Settlement completion timestamp

data.settlement.settlement_amount

number<float>

Settlement amount

data.settlement.settlement_currency

string

Settlement currency

data.settlement.utr_number

string

UTR number for the settlement

data.settlement.number_of_transactions

integer

Number of transactions in settlement

data.settlement.created_date

string<date-time>

Settlement creation timestamp

data.refund

object[]

required

Array of refunds associated with this payment

Show child attributes

data.refund.refund_id

string

Unique identifier for the refund.

data.refund.payment_id

string

The ID of the payment that was refunded.

data.refund.refund_status

string

The status of the refund.

data.refund.message

string | null

A message providing more detail about the refund status.

data.refund.bank_ref_num

string | null

The bank reference number for the refund.

data.refund.refund_amount

number<float>

The refunded amount.

data.refund.refunded_at

string<date-time> | null

The timestamp of when the refund was completed.

data.collection_mode

enum<string>

required

Payment collection mode

Available options:

HOSTED_PAYMENT,

DIRECT_PAYMENT

data.mop_type

enum<string>

required

Method of payment

Available options:

UPI,

CREDIT_CARD,

DEBIT_CARD,

NET_BANKING,

QR

data.status

enum<string>

required

Payment status

Available options:

PENDING,

CAPTURED,

FAILED

data.created_date

string<date-time>

required

Payment creation timestamp

data.bank_ref_num

string | null

Bank reference number

data.mop_detail

UPI Details · object

Method of payment specific details - structure varies based on mop_type

UPI Details
Card Details
Net Banking Details

Show child attributes

data.mop_detail.upi_id

string

required

UPI ID for UPI payments

data.payment_completed_at

string<date-time> | null

Payment completion timestamp

data.status_message

string | null

Payment status message

List Payments Create Merchant

⌘I

Order

Payment

Merchant

Settlement

Refund

Webhooks

Get Payment

Overview

Authorizations

Path Parameters

Response

Order

Payment

Merchant

Settlement

Refund

Webhooks

​Overview

Authorizations

Path Parameters

Response

Overview