• Callback Response
  • Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Refunds
      Guides
      Other links
      Mini Program Platform
  • Features for Investments PG
  • post Transaction Status API

    Use Case


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

    Request Attributes


    API Content Type: JSON

    Head1

    Head

    ATTRIBUTEDESCRIPTION
    version string(4)
    optional
    Version of the API.
    Example: v1
    channelId string(3)
    optional
    The parameter value identifies the Channel for which API call is initiated.
    Possible Values: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
    requestTimestamp string(15)
    optional
    EPOCH timestamp of the time at which request is being sent.
    Example: 1588402269
    clientId string(3)
    optional
    Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
    Example: C11
    signature string(108)
    mandatory
    Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum logic.
    Note: Create the signature using the body parameter of the request.
    Body1

    Body

    ATTRIBUTEDESCRIPTION
    mid string(20)
    mandatory
    Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.
    Example: INTEGR7769XXXXXX9383
    orderId string(50)
    mandatory
    The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”.
    Example: OREDRID_98765
    txnType string
    optional
    Transaction type of the payment
    Possible Values: PREAUTH, RELEASE, CAPTURE, WITHDRAW

    Response Attributes


    API Content Type: JSON

    Head2

    Head

    ATTRIBUTEDESCRIPTION
    version string(2)
    Version of the API passed in the request.
    Example: v1
    responseTimestamp string(15)
    EPOCH timestamp of the time at which response is being sent.
    Example: 1588402269
    channelId string(3)
    The parameter value identifies the Channel for which API call is initiated.
    Possible Values: WEBFor websites, the value to be passed should be "WEB", WAPFor Mobile websites/App, the value to be passed should be "WAP"
    clientId string(3)
    Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.
    Example: C11
    signature string(108)
    Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum logic.
    Note: Create the signature using the body parameter of the request.
    Body2

    Body

    ATTRIBUTEDESCRIPTION
    resultInfo object
    This parameter gives the information about the result of the API response
    ResultInfo +
    AttributeDescription
    resultCode string
    This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below
    resultStatus string
    This parameter indicates the status of API call.
    Possible Values: TXN_SUCCESS, TXN_FAILURE, PENDING
    resultMsg string(256)
    This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below
    txnId string
    transaction id of the payment
    Example: 202005081112128XXXXXX68470101509706
    bankTxnId string
    bank transaction id from the bank
    Example: 77700XXXX215242
    orderId string(50)
    Unique reference ID for an Order request generated by Merchant for Payment.
    Example: OREDRID_98765
    txnAmount string
    payment transaction Amount
    Possible Values: 1.00
    txnType string
    Transaction type of the payment
    gatewayName string(15)
    gateway Name used in payment
    Example: HDFC
    bankName string
    Bank Name used in payment
    Example: ICICI Bank
    mid string
    Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.
    Example: INTEGR7769XXXXXX9383
    paymentMode string
    Payment Mode used in payment
    Possible Values: PPIFor Paytm Wallet, UPIFor Bhim Upi, CCFor Credit Card, DCFor Debit Card, NBFor Net Banking,
    refundAmount string
    refund Amount of the payment
    Example: 1.00
    txnDate string
    transaction Date
    Example: 2020-05-05 14:00:28
    subsId string
    Subscription ID - Only Subscription flow
    payableAmount string
    Original order value before offer was applied.
    Only for SimplifiedPaymentOffers (Bank Offers).
    paymentPromoCheckoutData string
    Only for SimplifiedPaymentOffers (Bank Offers).
    promocode: Actual promocode which got applied
    promotext: Promo message
    savings: Benefit amount
    redemptionType: discount/cashback

    Response Codes and Messages


    resultCoderesultStatusresultMsg
    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
    335TXN_FAILUREMid is invalid
    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.
    501TXN_FAILUREServer Down
    810TXN_FAILURETxn Failed
    StagingProduction
    REQUESTRESPONSE
    curl -X POST 'https://securegw-stage.paytm.in/v3/order/status' \
    --header 'Content-Type: application/json' \
    --data '{"body":{"mid":"{mid}","orderId":"{order-id}"},"head":{"signature":"{signature}"}}'