• Getting Started
    • Website Integration
      Mobile Integration (Android/IOS)
      Enterprise Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Webhooks
      Testing
      Refunds
      Guides
      Other Processes

      Transaction Status API

      Checksum required: Yes

      Use Case


      • To re-verify the status of transaction before delivering the product or service to the customer, merchant has to match the Order ID & transaction amount returned in the response of this API against that sent in transaction request. In case of mismatch, product or service should not be fulfilled. Additionally the terminal status of transaction provided should be treated as the final status of transaction.
      • To fetch status of a payment transaction where real time response was not provided (due to system failures, API timeout etc.).
      • To fetch terminal status of transaction when the status was communicated as pending in response of process transaction.

      Request Attributes

      API Content format: JSON

      ATTRIBUTEDESCRIPTIONMANDATORY
      MID String(20)This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MID is available here & production MID will be available once your activation is complete.Yes
      ORDERID String(50)Order ID is merchant’s unique reference ID for a transaction passed in the transaction payload. This is Order ID for which the transaction status needs to be fetched.Yes
      CHECKSUMHASH String(108)Signature to avoid tampering. Generated using server side checksum utility available here.Yes
      TXNTYPE String(10)The type of transaction whose status needs to be checked by merchant possible value PREAUTH/ RELEASE/ CAPTURE/ WITHDRAW.No

      Response Attributes

      ATTRIBUTEDESCRIPTION
      MID String(20)This is a unique identifier provided to every merchant by Paytm.
      TXNID String(64)This is a unique Paytm transaction ID corresponding to OrderID for which status is being checked.
      ORDERID String(50)Order ID is merchant’s unique reference ID for a transaction sent in request.
      BANKTXNID String(50)The transaction ID sent by the bank. In case of Paytm proprietary instruments too, there is unique reference number generated by Paytm's system. In case the transaction does not reach the bank, this will be NULL or empty string. Primary reason for this is user dropping out of the payment flow before the transaction reaches to bank to servers.
      TXNAMOUNT String(10)Order value of the transaction in INR. Merchant should validate this amount against that send in transaction request payload. In case the amount does not match, merchant should not provide the services to customer. This is needed to avoid request and response tampering possible at the time of transaction.
      STATUS String(20)This contains the transaction status and has only three values: TXN_SUCCESS, TXN_FAILURE & PENDING.
      RESPCODE String(10)Codes refer to a particular reason of payment failure. List in this PDF.
      RESPMSG String(500)Description message attached with each respcode. List in this PDF.
      TXNDATE DateTimeDate and time of transaction in the format "yyyy-MM-dd HH:mm:ss.S"
      Eg- “2015-11- 02 11:40:46.0”
      GATEWAYNAME String(15)Gateway used by Paytm to process the transactions. For Credit,Debit Cards and UPI - Gateway used to process the transaction.
      For example, if HDFC gateway has been used to process SBI credit card transactions, the value will be HDFC.
      For Net banking & wallet, value will be Issuing Bank name and Wallet respectively.
      BANKNAME String(500)Name of issuing bank of the payment instrument used by customer. For Credit Cards, Debit Cards, Netbanking - Name of the issuing bank.
      Example in case customer uses SBI's credit card, the value will be "SBI”.
      For Paytm Wallet, value will be Wallet.
      In case of UPI, this parameter will not be present in the response.
      PAYMENTMODE String(15)The payment mode used by customer for transaction
      Credit card – CC
      Debit card - DC
      Net banking - NB
      UPI - UPI
      Paytm wallet – PPI
      Postpaid - PAYTMCC
      TXNTYPE String(5)The value of this parameter is "SALE" for the payment.
      REFUNDAMT String(10)Total cumulative refund amount against this transaction. For example for a transaction. with order value as INR 100, there has been two refunds of INR 20 & INR 30 historically, then REFUNDAMT will be INR 50.

      Response codes and Messages

      RESPCODESTATUSRESPMSG
      01TXN_SUCCESSTxn Success
      227TXN_FAILUREYour payment has been declined by your bank. Please contact your bank for any queries. If money has been deducted from your account, your bank will inform us within 48 hrs and we will refund the same.
      235TXN_FAILUREWallet balance Insufficient, bankName=WALLET
      295TXN_FAILUREYour payment failed as the UPI ID entered is incorrect. Please try again by entering a valid VPA or use a different method to complete the payment.
      334TXN_FAILUREInvalid Order ID
      400PENDINGTransaction status not confirmed yet.
      401TXN_FAILUREYour payment has been declined by your bank. Please contact your bank for any queries. If money has been deducted from your account, your bank will inform us within 48 hrs and we will refund the same.
      402PENDINGLooks like the payment is not complete. Please wait while we confirm the status with your bank.
      810TXN_FAILURETxn Failed

      Endpoints

      Staging: https://securegw-stage.paytm.in/order/status

      Production: https://securegw.paytm.in/order/status

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/order/status' --header 'Content-Type: application/json' --data '{"MID":"{mid}","ORDERID":"{order-id}","CHECKSUMHASH":"{checksum}"}'