Get Order By Merchant Order Id

Request

Query Params

merchantOrderId

string

optional

Merchant's orderId passed in create order API

Example:

MOI76545678

Header Params

merchantAccessKey

string

required

Authorization

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/api/v0/orders?merchantOrderId=MOI76545678' \
--header 'merchantAccessKey;' \
--header 'Authorization;'

Responses

🟢200OK

application/json

Body

response_code

integer <int32>

optional

response_message

string

optional

payload

object (OrderGetResponse)

optional

orderId

string

optional

The unique identifier for the order.

created

string <date-time>

optional

The timestamp indicating when the order was created.

lastModified

string <date-time>

optional

The timestamp indicating when the order was last modified.

merchantOrderId

string

optional

The merchant-specific identifier for the order.

merchantIdentifierKey

string

optional

The merchant's unique identifier key associated with the order.

amount

number

optional

The total amount associated with the order.

currency

string

optional

The currency in which the order amount is specified.

returnUrl

string

optional

The URL to which the customer will be redirected after completing the payment.

notifyUrl

string

optional

The URL where notifications regarding the order will be sent.

status

enum<string>

optional

The current status of the order.

Allowed values:

CREATEDCHECKOUT_RENDEREDPAIDCANCELLEDATTEMPTEDEXPIREDPAYMENT_CONFIRMATION_PENDING

customerInfo

object (CustomerDetail)

optional

Information about the customer associated with the order.

orderMessage

string

optional

Additional message or information related to the order.

orderDate

string <date-time>

optional

The date when the order was placed.

customParameters

object

optional

transactions

array[object (OrderTransactionResponse) {18}]

optional

Details of transactions associated with the order.

merchantName

string

optional

paymentDetail

object (OrderPaymentDetail)

optional

Example

{
  "response_code": 0,
  "response_message": "string",
  "payload": {
    "orderId": "string",
    "created": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "merchantOrderId": "string",
    "merchantIdentifierKey": "string",
    "amount": 0,
    "currency": "string",
    "returnUrl": "string",
    "notifyUrl": "string",
    "status": "CREATED",
    "customerInfo": {
      "firstName": "string",
      "lastName": "string",
      "address": {
        "streetName": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zipcode": "string"
      },
      "email": "string",
      "phoneNumber": "string"
    },
    "orderMessage": "string",
    "orderDate": "2019-08-24T14:15:22Z",
    "customParameters": {
      "property1": "string",
      "property2": "string"
    },
    "transactions": [
      {
        "transactionId": "string",
        "created": "2019-08-24T14:15:22Z",
        "lastModified": "2019-08-24T14:15:22Z",
        "type": "SALE",
        "amount": 0,
        "currency": "string",
        "status": "CREATED",
        "paymentDetail": {
          "paymentMode": "NET_BANKING",
          "cardHolderName": "string",
          "cardNumber": "string",
          "expiry": "string",
          "cardType": "CREDIT_CARD",
          "cardSchemeType": "VISA",
          "bankCode": "string",
          "bankName": "string",
          "accountNumber": "string",
          "ifsc": "string"
        },
        "bankResponse": {
          "terminalID": "string",
          "bankTransactionId": "string"
        },
        "txnMessage": "string",
        "txnDate": "2019-08-24T14:15:22Z",
        "surcharge": 0,
        "surchargeGst": 0,
        "finalAmount": 0,
        "txnMsg": "string",
        "mdr": 0,
        "mdrGst": 0,
        "transactionAmount": 0
      }
    ],
    "merchantName": "string",
    "paymentDetail": {
      "accountNumber": "stringstr",
      "ifsc": "KKBK0000432"
    }
  }
}