Enkash APIs
HomePayment GatewayPayoutsCreate Account
HomePayment GatewayPayoutsCreate Account
Login
  1. Order
  • Explore Our Product Suite
  • Payment Gateway
    • Payment Gateway Overview
    • Getting Started
    • Payment Methods
    • Integration
    • API Endpoints
    • APIs
      • Authorisation
        • Get Authorization Token
      • Order
        • Create Order
          POST
        • Get Order Status
          GET
        • Get Order By Merchant Order Id
          GET
        • Get BNPL Payment Modes
          GET
        • Get Dynamic QR Code
          GET
        • UPI Intent Links
          GET
      • Payment
        • Submit Payment Detail
        • Get Transaction Status
        • Validate OTP
        • Resend OTP
        • Payment Notify Request
        • Get UPI Transaction Status
        • Verify VPA
      • Refund
        • Refund
      • Settlement
        • Settlement Reporting
        • Get Settlement Payout By ID
        • Search Settlement Payouts
      • Split Settlement
        • Create Split Settlement Account
        • Update Split Settlement Account
        • Get All Split Settlement Account
        • Deactivate Split Settlement Account
        • Activate Split Settlement Account
        • Submit Payment with Split Details
        • Edit/Deferred Split Settlement
      • E-Commerce Plugins
      • Payment Button
      • Qr Code
        • Create Qr Code
        • Get QR Code
        • Search QR Code
        • createCustomer
        • searchCustomer
        • Cancel QR Code
      • UPI Mandate
        • Create UPI Mandate
        • Update UPI Mandate
        • Revoke UPI Mandate
        • Get UPI Mandate
        • UPI mandate create callback
        • Mandate Pre-debit Notification
        • Execute mandate debit
        • Mandate Debit callback
      • Payment Links
        • Payment Links Overview
        • Payment Link APIs
        • Payment Link
          • Create Payment Link
          • Get Payment Link Details
          • Delete Payment Link
        • Payment Link Webhook
          • Payment Link Webhook Request
  • Payouts
    • Payouts Overview
    • Payouts Sign Up
    • Payout Methods
    • Payout API Response Codes
    • Payouts Integration Steps
    • Encrypting and Decrypting Payload
    • Payouts Status Codes
    • Get Authentication Token
      • Get Authentication Token
    • Beneficiary Apis
      • Create Beneficiary
      • Search Beneficiary
      • Delete Beneficiary
    • Transfer Apis
      • Create Payout
      • Search Payouts
      • Create Batch Payout
    • Payout Account Apis
      • Get Balance
      • Get Source Bank Account Details
      • Add Source Bank Account
      • Fetch Bank Statement
    • Webhook Data Apis
      • Get Webhook Data
      • Create Webhook Data
  • Prepaid Cards
    • About Prepaid Card
    • Key Capabilities
    • Getting Started
    • APIs
      • API Access & Authorization
      • Encryption & Decryption Guide
      • Auth Token
      • Create Card Account
      • Create Gift Card
      • Create Prepaid Card
      • Set Card PIN
      • Load Card Balance
      • Get Card Account Details
      • Generate Card OTP
      • View Card Details
      • Card Usage Controls
      • Get Card Usage Limits
      • Request Card Replacement
      • Block Card
      • Order Physical Card
      • Get Card Details
      • Get Transaction Details
      • Get All Transaction details
  • Bharat Connect (BBPS)
    • About Bharat Connect
    • Invoice Payments
      • Invoice
        • Create Invoice
        • Confirm Invoice
        • Status Change Invoice
        • Edit Invoice
      • Payment
        • Pay Invoices
        • Payment Confirmation
      • Financing
        • Request Financing
        • Share Bid
        • Respond Bid
      • Onboarding
        • Register Check Entity
        • Search Entity
        • Register Entity
        • Registration Id
      • cdNote
        • Send CdNote Request
        • Confirm CdNote Request
        • Status Change CdNote Request
      • Purchase Order
        • Send Purchase Order Request
        • Confirm Purchase Order Request
        • Edit Purchase Order Request
        • Status Change Purchase Order Request
      • webhook-invoice
        • Webhook Create Invoice Request
        • Webhook Create Invoice Response
        • Webhook Confirm Invoice Request
        • Webhook Confirm Invoice Response
        • Webhook Status Change Invoice Request
        • Webhook Status Change Invoice Response
        • Webhook Edit Invoice Request
        • Webhook Edit Invoice Response
      • webhook-payments
        • Webhook Payment Request
        • Webhook Payment Confirmation Request
        • Webhook Payment Response
        • Webhook Payment Confirmation Response
      • webhook-business-onboarding
        • Webhook Check Entity Response
        • Webhook Register Entity Response
        • Webhook Search Entity Response
        • Webhook Registration Id Response
      • webhook-financing
        • Webhook Financing Response
        • Webhook Respond Bid Response
        • Webhook Share Bid Request
      • webhook-cdNote
        • Webhook Send CdNote Request
        • Webhook Send CdNote Response
        • Webhook Confirm CdNote Request
        • Webhook Confirm CdNote Response
        • Webhook Status Change CdNote Request
        • Webhook Status Change CdNote Response
      • Webhook Purchase Order
        • Webhook Send Purchase Order Request
        • Webhook Send Purchase Order Response
        • Webhook Confirm Purchase Order Request
        • Webhook Confirm Purchase Order Response
        • Webhook Edit Purchase Order Request
        • Webhook Edit Purchase Order Response
        • Webhook Status Change Purchase Order Request
        • Webhook Status Change Purchase Order Response
    • Bill Payments
      • Bill Payments Overview
      • Utility API Response Handling
      • Get Authentication Token
      • Get BillerTypes
      • Get Billers
      • Fetch Bill
      • Create Bill API
      • Create Bill Without Bill Fetch
      • Bill Payment
      • Utility Bill Approval API
      • Get Utility Bill Status
      • Get Utility Bill by Reference Id
      • Get Utility Bills Detail
      • Bill Payment Webhook
  • Accounts Payable
    • About AP Management Tool
    • Vendor Management
      • Create Vendor
      • Create Bulk Vendors
      • Update Bulk Vendors
      • Get Beneficiaries (V1)
      • Get Beneficiaries
      • Change Vendor Status
      • Get Beneficiary
    • Invoice Management
      • Payout Apis
        • validateInvoices
        • initiate
        • Search Payouts V1
        • bulkCreatePayout
        • Create Payout
        • Update Payouts
        • Search Payouts
        • createBulkPayoutForPartnerIntegration
        • Update Bulk Payouts
        • Update Approval Status
        • Get Invoice Data
        • Delete Payout
    • Bharat Connect 2.0 AP
      • Confirm Invoice Request
      • Payment Request
    • Update Beneficiary
  • Account Receivable
    • Accounts Receivable Overview
    • Get Authentication Token Copy
      • Get Authentication Token
    • Customer Management
      • Customer Apis
        • Activate customer
        • createBulkCustomer
        • bulkUpdate
        • Deactivate customer
        • deleteCustomerByCustomerId
        • updateCustomer
    • Customer Contacts Management
      • Customer Apis
        • getCustomerContactDetails
    • Invoice Management
      • invoice-controller
        • createInvoice
        • invoiceBulkUpload
        • Dispatch Invoice Collection
        • Delete Invoice Collection
        • searchCollectionInvoices
        • getInvoice
        • updateInvoice
    • Payment Reminders
      • customer-reminder-controller
        • createCustomerReminder
        • getCustomerReminders
        • getCustomerReminder
        • deleteReminder
        • updateCustomerReminder
    • Bharat Connect 2.0 AR
      • Payment Confirmation Request
      • Change Invoice Status Request
      • Bulk Create Invoice
  • Expense Management
    • Expense Management Overview
    • Sign Up - Expense Management
    • About Authorization
    • Expenses
    • Advance
    • Token API
  • Rewards & Incentives
    • About Rewards
    • Getting Started
    • Encryption & Decryption Guide
    • Reward Allocation
    • Incentive Allocation
    • APIs
      • Token APIs
        • Authentication
        • Single Sign On (SSO)
      • Reward Allocation
        • Create And Allocate Points
        • Bulk Create And Allocate Rewards
        • Get Reward Account Details
        • Get Reward Transaction Details
        • Get User Details
        • Get User Card Details
      • Incentive Allocation
        • Incentive Create And Allocation
        • Get Incentive Transaction details
        • Get User Details
      • Redemption
        • User Authentication
        • Get Cart for User
        • Search Catalog
        • Get Product Catalog Details
        • Get Product Configs (Denominations)
        • Add to cart
        • Update Cart
        • Create Order
        • Order Search
        • create order
        • Fetch Order Info by Partner order Reference id
      • Point Management
        • Overview
        • Create Event
        • Get Event
        • Update Event
        • Allocate Coins
        • Get Balance
  • Verification Suite
    • Verification Suite Overview
    • Bank Account Verification
      • Bank Account Verification PennyLess/PennyDrop
    • GSTN Verification
      • Gstin Verification
    • PAN Verification
      • Pan Verification
    • UPI(VPA) Verification
      • Vpa Verification
  1. Order

Get Order Status

GET
/api/v0/orders/{orderId}
order-controller
Get the order status using orderId

Request

Path Params
orderId
string 
required
The unique identifier for the order in your system your provided during create order.
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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v0/orders/' \
--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"
        }
    }
}
Previous
Create Order
Next
Get Order By Merchant Order Id
Built with