Get Status

Use this API to return the payment status of an existing order. This can also be used to query order status at any point in time.

Click to view the detailed response parameters and response codes.

Response Parameters

ParameterDescription
statusStatus of API call. Values are - OK and ERROR.
paymentLinkLink of payment page for that order. Returned when the status is OK.
reasonReason for failure when the status is ERROR.
txStatusTransaction status, if a payment has been attempted.
txTimeTransaction time, if payment has been attempted.
txMsgTransaction message, if payment has been attempted.
referenceIdTransaction reference ID, if payment has been attempted.
paymentModePayment mode of transaction, if payment has been attempted.
orderCurrencyCurrency of the order.
paymentDetails.paymentModePayment mode of transaction, if payment has been attempted.
paymentDetails.bankNameName of the bank if payment has been attempted (only in case of Netbanking).
paymentDetails.cardNumberMasked card number if payment has been attempted (only in case of Debit & Credit Cards).
paymentDetails.cardCountryCountry code of the card if payment has been attempted (only in case of Debit & Credit Cards).
paymentDetails.cardSchemeScheme of the card (Example: VISA) if payment has been attempted (only in case of Debit & Credit Cards).

 

Other Sample Responses

Unsuccessful payment attempt against an order:

The txStatus would be CANCELLED in the below response if a user lands on the payment page and clicks on 'back to merchant' instead of selecting a payment mode and proceeding with the transaction.

Payment details are only available for Netbanking and Credit/Debit Cards in the below response.

{
    "orderStatus": "ACTIVE",
    "txStatus": "PENDING",
    "txTime": "2018-03-29 15:33:42",
    "txMsg": null,
    "referenceId": "2610",
    "paymentMode": "NET_BANKING",
    "orderCurrency": "INR",
    "paymentDetails": {
        "paymentMode": "NET_BANKING",
        "bankName": "Yes Bank Ltd"
    },
    "status": "OK"
}

Succesful payment made against an order:

{
    "orderStatus": "PAID",
    "txStatus": "SUCCESS",
    "txTime": "2017-05-08 20:35:11",
    "txMsg": "transaction successful",
    "referenceId": "2602",
    "paymentMode": "AIRTEL_MONEY",
    "orderCurrency": "INR",
    "status": "OK"
}

Order status when a transaction gets FLAGGED and then goes to SUCCESS/CANCELLED:

{
     "orderStatus": "PROCESSED",
    "txStatus": "FLAGGED",    // This will get updated based on whether the transaction was approved (SUCCESS) or rejected (CANCELLED)
    "txTime": "2017-05-08 20:35:11",
    "txMsg": "Transaction successful",
    "referenceId": "2603",
    "paymentMode": "CREDIT_CARD",
    "orderCurrency": "INR",
    "paymentDetails": {
        "paymentMode": "CREDIT_CARD",
        "cardNumber": "3400XXXXX0009",
        "cardCountry": "IN",
        "cardScheme": "AMEX"
    },
    "status": "OK"
}

For prepaid cards - Order status when a transaction is successful, and payment has been made via prepaid card:

A new object paymentDetails is added in the API response for prepaid cards. Details like payment mode, card number, card country, card scheme, and auth ID code is available in the response.

{

  "orderStatus": "PAID",
  "orderAmount": "30000.00",
  "status": "OK",
  "txStatus": "SUCCESS",
  "txTime": "2021-05-04 14:45:36",
  "txMsg": "Transaction has been approved.",
  "referenceId": "192871148",
  "paymentMode": "PREPAID_CARD",
  "orderCurrency": "INR",
  "paymentDetails": {
    "paymentMode": "PREPAID_CARD",
    "cardNumber": "463907XXXXXX5119",
    "cardCountry": "IN",
    "cardScheme": "VISA",
    "authIdCode": "048885"
  }
}

Response Codes

Sub CodeStatusDescription
200OKPlease provide a valid appId
200OKPlease provide a valid secretKey
200OKPlease provide a valid orderId

 

Language