# Get Order By Merchant Order Id
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v0/orders:
get:
summary: Get Order By Merchant Order Id
deprecated: false
description: >-
:::highlight purple 📌
Use this API to retrieve the status of an order by providing the
merchantOrderId. This allows you to track the order’s progress based on
your internal reference ID and keep your application or users updated
accordingly.
:::
operationId: getOrderByMerchantOrderId
tags:
- Payment Gateway/APIs - Payment Gateway /Order
- order-controller
parameters:
- name: merchantOrderId
in: query
description: Merchant's orderId passed in create order API
required: true
example: MOI76545678
schema:
type: string
- name: merchantAccessKey
in: header
description: The access key generated for your account
required: true
example: ''
schema:
type: string
- name: Authorization
in: header
description: Token generated with your Access key and secret key
required: true
example: ''
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
x-apidog-refs:
01KM190HWVRGN1YMD6GC3ED6MF:
$ref: '#/components/schemas/ApplicationResponseOrderGetResponse'
x-apidog-overrides:
payload: &ref_2
type: object
x-apidog-refs:
01KM190V892D78TNVN1M2BQ9SY: &ref_3
$ref: '#/components/schemas/OrderGetResponse'
x-apidog-overrides:
paymentDetail: &ref_1
type: object
properties:
accountNumber:
type: string
description: >-
Required for UPI TPV flow for non seamless
integration
minLength: 9
maxLength: 36
ifsc:
type: string
description: >-
Required for UPI TPV flow for non seamless
integration
minLength: 11
examples:
- KKBK0000432
maxLength: 11
pattern: ^[A-Z]{4}0[A-Z0-9]{6}$
x-apidog-orders:
- accountNumber
- ifsc
description: Payment related information for UPI TPV flow
x-apidog-ignore-properties: []
x-apidog-orders:
- 01KM190V892D78TNVN1M2BQ9SY
properties:
orderId:
type: string
description: The unique identifier for the order.
created:
type: string
format: date-time
description: >-
The timestamp indicating when the order was
created.
lastModified:
type: string
format: date-time
description: >-
The timestamp indicating when the order was last
modified.
merchantOrderId:
type: string
description: The merchant-specific identifier for the order.
merchantIdentifierKey:
type: string
description: >-
The merchant's unique identifier key associated
with the order.
amount:
type: number
description: The total amount associated with the order.
currency:
type: string
description: >-
The currency in which the order amount is
specified.
returnUrl:
type: string
description: >-
The URL to which the customer will be redirected
after completing the payment.
notifyUrl:
type: string
description: >-
The URL where notifications regarding the order
will be sent.
status:
type: string
description: The current status of the order.
enum:
- CREATED
- PAID
- CANCELLED
- ATTEMPTED
- EXPIRED
x-apidog-enum:
- value: CREATED
name: ''
description: ''
- value: PAID
name: ''
description: ''
- value: CANCELLED
name: ''
description: ''
- value: ATTEMPTED
name: ''
description: ''
- value: EXPIRED
name: ''
description: ''
customerInfo:
type: object
properties:
firstName:
type: string
description: >-
The first name of the customer. Accepts
alphabetic characters.
lastName:
type: string
description: >-
The last name of the customer. Accepts
alphabetic characters.
address:
type: object
properties:
streetName:
type: string
city:
type: string
state:
type: string
country:
type: string
zipcode:
type: string
x-apidog-orders:
- streetName
- city
- state
- country
- zipcode
description: >
The address of the customer. Accepts
alphanumeric characters and special symbols.
x-apidog-ignore-properties: []
email:
type: string
description: >
The email address of the customer. Must be in
a valid email format.
phoneNumber:
type: string
description: >-
The phone number of the customer. Please
exclude +91 ISD code.
customerIpAddress:
type: string
description: The Ip address of the customer
x-apidog-orders:
- firstName
- lastName
- address
- email
- phoneNumber
- customerIpAddress
description: ' Information about the customer associated with the order. It typically includes details such as first name, last name, address, email, and phone number.'
required:
- customerIpAddress
x-apidog-ignore-properties: []
orderMessage:
type: string
description: >-
Additional message or information related to the
order.
orderDate:
type: string
format: date-time
description: The date when the order was placed.
customParameters:
type: array
items:
type: string
transactions:
type: array
items:
type: object
x-apidog-refs:
01KJDMMWF5PZ0B3XVE7KZBHCX4: &ref_6
$ref: >-
#/components/schemas/OrderTransactionResponse
x-apidog-overrides:
status: &ref_0
type: string
description: The current status of the transaction.
enum:
- CREATED
- PENDING_WITH_BANK
- SUCCESS
- FAILED
- CANCELLED
- CHECKOUT_RENDERED
- REFUNDED
- PARTIALLY_REFUNDED
- AUTHORIZED
- PROCESSING
- HOLD
- EXPIRED
x-apidog-enum:
- value: CREATED
name: ''
description: ''
- value: PENDING_WITH_BANK
name: ''
description: ''
- value: SUCCESS
name: ''
description: ''
- value: FAILED
name: ''
description: ''
- value: CANCELLED
name: ''
description: ''
- value: CHECKOUT_RENDERED
name: ''
description: ''
- value: REFUNDED
name: ''
description: ''
- value: PARTIALLY_REFUNDED
name: ''
description: ''
- value: AUTHORIZED
name: ''
description: ''
- value: PROCESSING
name: ''
description: ''
- value: HOLD
name: ''
description: ''
- value: EXPIRED
name: ''
description: ''
x-apidog-orders:
- 01KJDMMWF5PZ0B3XVE7KZBHCX4
properties:
transactionId:
type: string
description: The unique identifier for the transaction.
created:
type: string
format: date-time
description: >-
The timestamp indicating when the
transaction was created.
lastModified:
type: string
format: date-time
description: >-
The timestamp indicating when the
transaction was last modified.
type:
type: string
description: The type of transaction.
enum:
- SALE
- REFUND
x-apidog-enum:
- value: SALE
name: ''
description: ''
- value: REFUND
name: ''
description: ''
amount:
type: number
description: The amount associated with the transaction.
currency:
type: string
description: >-
The currency in which the transaction amount
is specified.
status: *ref_0
paymentDetail: &ref_4
$ref: '#/components/schemas/PaymentDetailResponse'
bankResponse: &ref_5
$ref: '#/components/schemas/BankResponseModel'
description: Response from the bank for the transaction.
txnMessage:
type: string
description: >-
Additional message or information related to
the transaction.
txnDate:
type: string
format: date-time
description: The date when the transaction was initiated.
surcharge:
type: number
description: The surcharge amount for the transaction.
surchargeGst:
type: number
description: GST applied on the surcharge amount.
finalAmount:
type: number
description: >-
The final amount after considering surcharge
and GST.
txnMsg:
type: string
description: >-
Additional message or information related to
the transaction.
mdr:
type: number
description: >-
Merchant Discount Rate (MDR) applied on the
transaction.
mdrGst:
type: number
description: >-
GST applied on the Merchant Discount Rate
(MDR).
transactionAmount:
type: number
description: The transaction amount.
x-apidog-ignore-properties:
- transactionId
- created
- lastModified
- type
- amount
- currency
- status
- paymentDetail
- bankResponse
- txnMessage
- txnDate
- surcharge
- surchargeGst
- finalAmount
- txnMsg
- mdr
- mdrGst
- transactionAmount
description: Details of transactions associated with the order.
merchantName:
type: string
paymentDetail: *ref_1
x-apidog-ignore-properties:
- orderId
- created
- lastModified
- merchantOrderId
- merchantIdentifierKey
- amount
- currency
- returnUrl
- notifyUrl
- status
- customerInfo
- orderMessage
- orderDate
- customParameters
- transactions
- merchantName
- paymentDetail
x-apidog-orders:
- 01KM190HWVRGN1YMD6GC3ED6MF
properties:
response_code:
type: integer
format: int32
response_message:
type: string
payload: *ref_2
x-apidog-ignore-properties:
- response_code
- response_message
- payload
example: "{\n\_\_\_\_\"response_code\": 0,\n\_\_\_\_\"response_message\": \"Success\",\n\_\_\_\_\"payload\": {\n\_\_\_\_\_\_\_\_\"orderId\": \"ORD1772087623322Ie8SR\",\n\_\_\_\_\_\_\_\_\"created\": \"2026-02-26 12:03:43\",\n\_\_\_\_\_\_\_\_\"lastModified\": \"2026-02-26 12:05:22\",\n\_\_\_\_\_\_\_\_\"merchantOrderId\": \"RANDO0MID123\",\n\_\_\_\_\_\_\_\_\"merchantIdentifierKey\": \"ZJjAg195FnUlR1535\",\n\_\_\_\_\_\_\_\_\"amount\": 100.00,\n\_\_\_\_\_\_\_\_\"currency\": \"INR\",\n\_\_\_\_\_\_\_\_\"returnUrl\": \"https://glaring-version.net/\",\n\_\_\_\_\_\_\_\_\"notifyUrl\": \"https://inconsequential-annual.biz/\",\n\_\_\_\_\_\_\_\_\"status\": \"PAID\",\n\_\_\_\_\_\_\_\_\"customerInfo\": {\n\_\_\_\_\_\_\_\_\_\_\_\_\"firstName\": \"Merlin\",\n\_\_\_\_\_\_\_\_\_\_\_\_\"lastName\": \"Collins\",\n\_\_\_\_\_\_\_\_\_\_\_\_\"email\": \"Emmitt37@yahoo.com\",\n\_\_\_\_\_\_\_\_\_\_\_\_\"phoneNumber\": \"9889890909\"\n\_\_\_\_\_\_\_\_},\n\_\_\_\_\_\_\_\_\"orderDate\": \"2026-02-26 12:03:43\",\n\_\_\_\_\_\_\_\_\"transactions\": [\n\_\_\_\_\_\_\_\_\_\_\_\_{\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"transactionId\": \"EK1772087711864KPsOb\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"created\": \"2026-02-26 12:05:11\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"lastModified\": \"2026-02-26 12:05:22\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"type\": \"SALE\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"amount\": 100.00,\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"currency\": \"INR\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"status\": \"SUCCESS\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"paymentDetail\": {\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"paymentMode\": \"CREDIT_CARD\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"cardHolderName\": \"test\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"cardNumber\": \"XXXX XXXX XXXX 6743\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"expiry\": \"12/2028\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"cardType\": \"CREDIT_CARD\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"cardSchemeType\": \"MASTERCARD\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"bankName\": \"JACK HENRY & ASSOCIATES\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"paymentToken\": \"154ffeffd0223ca9acf6\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"enkashPgCode\": \"PAPG_MOCK\"\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_},\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"txnMessage\": \"Completed.\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"txnDate\": \"2026-02-26 12:05:22\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"surcharge\": 0.0000,\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"surchargeGst\": 0.0000,\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"productCode\": \"DEFAULT\",\n\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\"merchantOrderId\": \"RANDO0MID123\"\n\_\_\_\_\_\_\_\_\_\_\_\_}\n\_\_\_\_\_\_\_\_],\n\_\_\_\_\_\_\_\_\"merchantName\": \"Vaishali Pawar\",\n\_\_\_\_\_\_\_\_\"productCode\": \"DEFAULT\"\n\_\_\_\_}\n}"
headers: {}
x-apidog-name: OK
'504':
description: ''
content:
application/json:
schema:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
example: |-
504 Gateway Time-out
504 Gateway Time-out
headers: {}
x-apidog-name: Bad Gateway
security: []
x-apidog-folder: Payment Gateway/APIs - Payment Gateway /Order
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-15938532-run
components:
schemas:
ApplicationResponseOrderGetResponse:
type: object
properties:
response_code:
type: integer
format: int32
response_message:
type: string
payload: *ref_3
x-apidog-orders:
- response_code
- response_message
- payload
x-apidog-ignore-properties: []
x-apidog-folder: ''
BankResponseModel:
type: object
properties:
terminalID:
type: string
bankTransactionId:
type: string
x-apidog-orders:
- terminalID
- bankTransactionId
x-apidog-ignore-properties: []
x-apidog-folder: ''
PaymentDetailResponse:
required:
- paymentMode
type: object
properties:
paymentMode:
type: string
enum:
- NET_BANKING
- UPI
- CREDIT_CARD
- DEBIT_CARD
- PREPAID_CARD
- PAY_LATER
- WALLET
- CORPORATE_CARD
- UPI_CREDIT_CARD
x-apidog-enum:
- value: NET_BANKING
name: ''
description: ''
- value: UPI
name: ''
description: ''
- value: CREDIT_CARD
name: ''
description: ''
- value: DEBIT_CARD
name: ''
description: ''
- value: PREPAID_CARD
name: ''
description: ''
- value: PAY_LATER
name: ''
description: ''
- value: WALLET
name: ''
description: ''
- value: CORPORATE_CARD
name: ''
description: ''
- value: UPI_CREDIT_CARD
name: ''
description: ''
cardHolderName:
type: string
cardNumber:
type: string
expiry:
type: string
cardType:
type: string
enum:
- CREDIT_CARD
- DEBIT_CARD
- PREPAID_CARD
cardSchemeType:
type: string
enum:
- VISA
- MASTERCARD
- AMEX
- DINERS
- DISCOVER
- JCB
- MAESTRO
- RUPAY
- UNKNOWN
bankCode:
type: string
bankName:
type: string
accountNumber:
type: string
ifsc:
type: string
x-apidog-orders:
- paymentMode
- cardHolderName
- cardNumber
- expiry
- cardType
- cardSchemeType
- bankCode
- bankName
- accountNumber
- ifsc
x-apidog-ignore-properties: []
x-apidog-folder: ''
OrderTransactionResponse:
type: object
properties:
transactionId: &ref_7
type: string
description: The unique identifier for the transaction.
created: &ref_8
type: string
format: date-time
description: The timestamp indicating when the transaction was created.
lastModified: &ref_9
type: string
format: date-time
description: The timestamp indicating when the transaction was last modified.
type:
type: string
description: The type of transaction.
enum: &ref_10
- SALE
- REFUND
x-apidog-enum:
- value: SALE
name: ''
description: ''
- value: REFUND
name: ''
description: ''
amount: &ref_11
type: number
description: The amount associated with the transaction.
currency: &ref_12
type: string
description: The currency in which the transaction amount is specified.
status:
type: string
description: The current status of the transaction.
enum:
- CREATED
- PENDING_WITH_BANK
- SUCCESS
- FAILED
- CANCELLED
- CHECKOUT_RENDERED
- REFUNDED
- PARTIALLY_REFUNDED
- AUTHORIZED
- PROCESSING
- HOLD
x-apidog-enum:
- value: CREATED
name: ''
description: ''
- value: PENDING_WITH_BANK
name: ''
description: ''
- value: SUCCESS
name: ''
description: ''
- value: FAILED
name: ''
description: ''
- value: CANCELLED
name: ''
description: ''
- value: CHECKOUT_RENDERED
name: ''
description: ''
- value: REFUNDED
name: ''
description: ''
- value: PARTIALLY_REFUNDED
name: ''
description: ''
- value: AUTHORIZED
name: ''
description: ''
- value: PROCESSING
name: ''
description: ''
- value: HOLD
name: ''
description: ''
paymentDetail: *ref_4
bankResponse: *ref_5
txnMessage: &ref_13
type: string
description: Additional message or information related to the transaction.
txnDate: &ref_14
type: string
format: date-time
description: The date when the transaction was initiated.
surcharge: &ref_15
type: number
description: The surcharge amount for the transaction.
surchargeGst: &ref_16
type: number
description: GST applied on the surcharge amount.
finalAmount: &ref_17
type: number
description: The final amount after considering surcharge and GST.
txnMsg: &ref_18
type: string
description: Additional message or information related to the transaction.
mdr: &ref_19
type: number
description: Merchant Discount Rate (MDR) applied on the transaction.
mdrGst: &ref_20
type: number
description: GST applied on the Merchant Discount Rate (MDR).
transactionAmount: &ref_21
type: number
description: The transaction amount.
x-apidog-orders:
- transactionId
- created
- lastModified
- type
- amount
- currency
- status
- paymentDetail
- bankResponse
- txnMessage
- txnDate
- surcharge
- surchargeGst
- finalAmount
- txnMsg
- mdr
- mdrGst
- transactionAmount
x-apidog-ignore-properties: []
x-apidog-folder: ''
OrderGetResponse:
type: object
properties:
orderId:
type: string
description: The unique identifier for the order.
created:
type: string
format: date-time
description: The timestamp indicating when the order was created.
lastModified:
type: string
format: date-time
description: The timestamp indicating when the order was last modified.
merchantOrderId:
type: string
description: The merchant-specific identifier for the order.
merchantIdentifierKey:
type: string
description: The merchant's unique identifier key associated with the order.
amount:
type: number
description: The total amount associated with the order.
currency:
type: string
description: The currency in which the order amount is specified.
returnUrl:
type: string
description: >-
The URL to which the customer will be redirected after completing
the payment.
notifyUrl:
type: string
description: The URL where notifications regarding the order will be sent.
status:
type: string
description: The current status of the order.
enum:
- CREATED
- PAID
- CANCELLED
- ATTEMPTED
- EXPIRED
x-apidog-enum:
- value: CREATED
name: ''
description: ''
- value: PAID
name: ''
description: ''
- value: CANCELLED
name: ''
description: ''
- value: ATTEMPTED
name: ''
description: ''
- value: EXPIRED
name: ''
description: ''
customerInfo:
type: object
properties:
firstName:
type: string
description: The first name of the customer. Accepts alphabetic characters.
lastName:
type: string
description: The last name of the customer. Accepts alphabetic characters.
address:
type: object
properties:
streetName:
type: string
city:
type: string
state:
type: string
country:
type: string
zipcode:
type: string
x-apidog-orders:
- streetName
- city
- state
- country
- zipcode
description: >
The address of the customer. Accepts alphanumeric characters and
special symbols.
x-apidog-ignore-properties: []
email:
type: string
description: >
The email address of the customer. Must be in a valid email
format.
phoneNumber:
type: string
description: The phone number of the customer. Please exclude +91 ISD code.
customerIpAddress:
type: string
description: The Ip address of the customer
x-apidog-orders:
- firstName
- lastName
- address
- email
- phoneNumber
- customerIpAddress
description: ' Information about the customer associated with the order. It typically includes details such as first name, last name, address, email, and phone number.'
required:
- customerIpAddress
x-apidog-ignore-properties: []
orderMessage:
type: string
description: Additional message or information related to the order.
orderDate:
type: string
format: date-time
description: The date when the order was placed.
customParameters:
type: array
items:
type: string
transactions:
type: array
items:
type: object
x-apidog-refs:
01KJDMMWF5PZ0B3XVE7KZBHCX4: *ref_6
x-apidog-orders:
- 01KJDMMWF5PZ0B3XVE7KZBHCX4
properties:
transactionId: *ref_7
created: *ref_8
lastModified: *ref_9
type:
type: string
description: The type of transaction.
enum: *ref_10
x-apidog-enum:
- value: SALE
name: ''
description: ''
- value: REFUND
name: ''
description: ''
amount: *ref_11
currency: *ref_12
status:
type: string
description: The current status of the transaction.
enum:
- CREATED
- PENDING_WITH_BANK
- SUCCESS
- FAILED
- CANCELLED
- CHECKOUT_RENDERED
- REFUNDED
- PARTIALLY_REFUNDED
- AUTHORIZED
- PROCESSING
- HOLD
- EXPIRED
x-apidog-enum:
- value: CREATED
name: ''
description: ''
- value: PENDING_WITH_BANK
name: ''
description: ''
- value: SUCCESS
name: ''
description: ''
- value: FAILED
name: ''
description: ''
- value: CANCELLED
name: ''
description: ''
- value: CHECKOUT_RENDERED
name: ''
description: ''
- value: REFUNDED
name: ''
description: ''
- value: PARTIALLY_REFUNDED
name: ''
description: ''
- value: AUTHORIZED
name: ''
description: ''
- value: PROCESSING
name: ''
description: ''
- value: HOLD
name: ''
description: ''
- value: EXPIRED
name: ''
description: ''
paymentDetail: *ref_4
bankResponse: *ref_5
txnMessage: *ref_13
txnDate: *ref_14
surcharge: *ref_15
surchargeGst: *ref_16
finalAmount: *ref_17
txnMsg: *ref_18
mdr: *ref_19
mdrGst: *ref_20
transactionAmount: *ref_21
x-apidog-ignore-properties:
- transactionId
- created
- lastModified
- type
- amount
- currency
- status
- paymentDetail
- bankResponse
- txnMessage
- txnDate
- surcharge
- surchargeGst
- finalAmount
- txnMsg
- mdr
- mdrGst
- transactionAmount
description: Details of transactions associated with the order.
merchantName:
type: string
paymentDetail:
type: object
properties:
accountNumber:
type: string
description: Required for UPI TPV flow for non seamless integration
minLength: 9
maxLength: 36
ifsc:
type: string
description: Required for UPI TPV flow for non seamless integration
minLength: 11
examples:
- KKBK0000432
maxLength: 11
pattern: ^[A-Z]{4}0[A-Z0-9]{6}$
x-apidog-orders:
- accountNumber
- ifsc
description: Payment related information for UPI TPV flow
x-apidog-ignore-properties: []
x-apidog-orders:
- orderId
- created
- lastModified
- merchantOrderId
- merchantIdentifierKey
- amount
- currency
- returnUrl
- notifyUrl
- status
- customerInfo
- orderMessage
- orderDate
- customParameters
- transactions
- merchantName
- paymentDetail
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes: {}
servers:
- url: https://ekpayout-uat.enkash.in
description: Testing Env
security: []
```