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

      Payment Status API

      Checksum required: Yes

      Use Case


      This API gets the transaction status corresponding to requested OrderId for specific merchant.

      Request Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      clientId StringClientId by which key checksum is created, required to validate the checksum. Eg C11No
      version StringVersion of the API. Current version is v1.No
      channelId enum (WEB/WAP)Channel through which call initiated
      WEB: Web server, WAP: Mobile device
      Yes
      requestTimestamp StringUNIX timestamp of the time request is being sentNo
      signature StringSignature encryption for validationYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      mid Stringmerchant idYes
      orderId Stringorder id of the paymentYes
      txnType StringTransaction type of the paymentNo

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTIONMANDATORY
      clientId StringClientId by which key checksum is created, required to validate the checksum. Eg C11No
      version StringVersion of the API passed in the request.No
      channelId enumChannel through which call initiated
      WEB: Web server, WAP: Mobile device
      Yes
      requestTimestamp StringUNIX timestamp of the time request is being sentNo
      signature StringSignature encryption for validationYes

      Body

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultInfo ResultInfoResultInfo Object contains result related informationYes
      txnId Stringtransaction id of the paymentNo
      bankTxnId Stringbank transaction id from the bankNo
      orderId Stringorder Id of the paymentYes
      txnAmount Stringpayment transaction AmountNo
      txnType Stringtransaction Type of the paymentNo
      gatewayName Stringgateway Name used in paymentNo
      bankName StringBank Name used in paymentNo
      mId Stringmerchant idYes
      paymentMode StringPayment Mode used in paymentNo
      refundAmount Stringrefund Amount of the paymentNo
      txnDate Stringtransaction DateNo

      ResultInfo

      ATTRIBUTEDESCRIPTIONMANDATORY
      resultCode StringResult code returned to merchant . Max length of result code can be 64Yes
      resultStatus enumResult Status of transaction
      (S:Success, F:Failure, U:Unknown)
      Yes
      resultMsg StringResult Message corresponding to transactionYes

      Response Codes and Messages

      resultCoderesultStatusresultMsg
      01TXN_SUCCESSTransaction Success
      402PENDINGPayment not complete, confirming status from bank
      334TXN_FAILUREInvalid Order Id
      335TXN_FAILUREMid is invalid
      501TXN_FAILUREServer Down

      Endpoints

      Staging: https://securegw-stage.paytm.in/merchant-status/api/v1/getPaymentStatus

      Production: https://securegw.paytm.in/merchant-status/api/v1/getPaymentStatus

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/merchant-status/api/v1/getPaymentStatus' --header 'Content-Type: application/json' --data '{"body":{"mid":"{mid}","orderId":"{order-id}"},"head":{"signature":"{signature}"}}'