Fetch Order Info by Partner order Reference id

This API faciltates fetching order details such as voucher code, pin and other important details.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

authorization

string

required

Example:

Bearer tYte80xqTDUodXslo2ShHle_eXo

Content-Type

string

required

Example:

application/json

Body Params application/json

orderId

string

required

Partner Order Reference I

Example

{
  "orderId": "OR631764TS4UC"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

paylod

object

required

orderId

string

required

Enkash Order Id

paymentStatus

string

required

Payment Status of Order:
SUCCESS , IN_PROGRESS, FAILED, CANCELLED, EXPIRED, REFUNDED

orderStatus

string

required

Order Status :
IN_PROGRESS, PENDING, SUCCESS, REFUNDED, EXPIRED

totalQuantity

integer

required

Total Quantity of vouchers placed in order

totalAmount

integer

required

Total Amount paid

orderAmount

integer

required

Total Order Amount (total amount after applying discounts on brands)

paidAmount

integer

required

Total Amount paid

partnerOrderReferenceId

string

required

Partner Order Reference Id

voucherDetailsList

array [object {3}]

required

response_message

string

required

response_code

string

required

Example

{
  "paylod": {
    "orderId": "12345",
    "paymentStatus": "SUCCESS",
    "orderStatus": "SUCCESS",
    "totalQuantity": 10,
    "totalAmount": 5000,
    "orderAmount": 4500,
    "paidAmount": 4500,
    "partnerOrderReferenceId": "REF123456789",
    "voucherDetailsList": [
      {
        "cardNumber": "1234567890123456",
        "pin": "1234",
        "expiryDate": "2025-12-31T23:59:59"
      },
      {
        "cardNumber": "6543210987654321",
        "pin": "5678",
        "expiryDate": "2026-06-30T23:59:59"
      }
    ]
  },
  "response_message": "Success",
  "response_code": "0"
}