# Get Order Status
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v0/orders/{orderId}:
get:
summary: Get Order Status
deprecated: false
description: >
:::highlight purple 📌
Use this API to retrieve the status of an order using the `orderId`, the
unique identifier generated by Enkash when the order was created. This
lets you track the order’s status throughout its lifecycle based on the
Enkash-issued ID.
:::
operationId: getOrderByOrderId
tags:
- Payment Gateway/APIs - Payment Gateway /Order
- order-controller
parameters:
- name: orderId
in: path
description: >-
The unique identifier for the order in your system your provided
during create order.
required: true
example: ''
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:
01KM197Y35N0E6FR2EPSXQQSE2:
$ref: '#/components/schemas/ApplicationResponseOrderGetResponse'
x-apidog-overrides:
payload: &ref_1
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_2
$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_3
$ref: '#/components/schemas/PaymentDetailResponse'
bankResponse: &ref_4
$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:
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-orders:
- 01KM197Y35N0E6FR2EPSXQQSE2
properties:
response_code:
type: integer
format: int32
response_message:
type: string
payload: *ref_1
x-apidog-ignore-properties:
- response_code
- response_message
- payload
example:
response_code: 0
response_message: Success
payload:
orderId: ORD1772018325252VspTV
created: '2026-02-25 16:48:45'
lastModified: '2026-02-25 16:51:06'
merchantOrderId: RAND66OMID12773
merchantIdentifierKey: ZJjAg195FnUlR1535
amount: 100
currency: INR
returnUrl: https://glaring-version.net/
notifyUrl: https://inconsequential-annual.biz/
status: PAID
customerInfo:
firstName: Merlin
lastName: Collins
email: Emmitt37@yahoo.com
phoneNumber: '9889890909'
orderDate: '2026-02-25 16:48:45'
transactions:
- transactionId: EK1772018449619dPgCl
created: '2026-02-25 16:51:06'
lastModified: '2026-02-25 16:51:06'
type: SALE
amount: 100
currency: INR
status: SUCCESS
paymentDetail:
paymentMode: UPI
paymentToken: mock@enkash
enkashPgCode: PAPG_MOCK
bankResponse:
bankTransactionId: INDT79pwEQlWTvX
txnMessage: Completed.
txnDate: '2026-02-25 16:51:06'
surcharge: 0
surchargeGst: 0
productCode: DEFAULT
merchantOrderId: RAND66OMID12773
merchantName: Vaishali Pawar
productCode: DEFAULT
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-8990250-run
components:
schemas:
ApplicationResponseOrderGetResponse:
type: object
properties:
response_code:
type: integer
format: int32
response_message:
type: string
payload:
$ref: '#/components/schemas/OrderGetResponse'
x-apidog-orders:
- response_code
- response_message
- payload
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_2
x-apidog-orders:
- 01KJDMMWF5PZ0B3XVE7KZBHCX4
properties:
transactionId: &ref_5
type: string
description: The unique identifier for the transaction.
created: &ref_6
type: string
format: date-time
description: The timestamp indicating when the transaction was created.
lastModified: &ref_7
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_8
- SALE
- REFUND
x-apidog-enum:
- value: SALE
name: ''
description: ''
- value: REFUND
name: ''
description: ''
amount: &ref_9
type: number
description: The amount associated with the transaction.
currency: &ref_10
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
- 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_3
bankResponse: *ref_4
txnMessage: &ref_11
type: string
description: Additional message or information related to the transaction.
txnDate: &ref_12
type: string
format: date-time
description: The date when the transaction was initiated.
surcharge: &ref_13
type: number
description: The surcharge amount for the transaction.
surchargeGst: &ref_14
type: number
description: GST applied on the surcharge amount.
finalAmount: &ref_15
type: number
description: The final amount after considering surcharge and GST.
txnMsg: &ref_16
type: string
description: Additional message or information related to the transaction.
mdr: &ref_17
type: number
description: Merchant Discount Rate (MDR) applied on the transaction.
mdrGst: &ref_18
type: number
description: GST applied on the Merchant Discount Rate (MDR).
transactionAmount: &ref_19
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:
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: ''
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_5
created: *ref_6
lastModified: *ref_7
type:
type: string
description: The type of transaction.
enum: *ref_8
x-apidog-enum:
- value: SALE
name: ''
description: ''
- value: REFUND
name: ''
description: ''
amount: *ref_9
currency: *ref_10
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_3
bankResponse: *ref_4
txnMessage: *ref_11
txnDate: *ref_12
surcharge: *ref_13
surchargeGst: *ref_14
finalAmount: *ref_15
txnMsg: *ref_16
mdr: *ref_17
mdrGst: *ref_18
transactionAmount: *ref_19
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: ''
securitySchemes: {}
servers:
- url: https://ekpayout-uat.enkash.in
description: Testing Env
security: []
```