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

      post Fetch Subscription Status API

      Use Case


      This API provides the status and the details of the subscription being asked.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      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
      version string(4)
      optional
      Version of the API.
      Example: v1
      requestTimestamp string(15)
      optional
      EPOCH timestamp of the time at which request is being sent.
      Example: 1588402269
      tokenType AES
      mandatory
      Would be AES or SSO . AES – then signature is mandatory for checksum validation. This is used by merchants SSO – then ssoToken in body is mandatory. This is used by Paytm APP.
      token string
      conditional
      token of the user
      signature string(108)
      conditional
      Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library
      Body1

      Body

      ATTRIBUTEDESCRIPTION
      subsId string
      Subscription ID - Only Subscription flow
      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
      custId string(64)
      mandatory
      Customer ID whose subscription is being cancelled

      Response Attributes


      API Content Type: JSON

      Head2

      Head

      ATTRIBUTEDESCRIPTION
      responseTimestamp string(15)
      EPOCH timestamp of the time at which response is being sent.
      Example: 1588402269
      tokenType AES
      Would be AES or SSO . AES – then signature is mandatory for checksum validation. This is used by merchants SSO – then ssoToken in body is mandatory. This is used by Paytm APP.
      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 parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library
      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: SUCCESS, FAILURE
      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
      subsId string
      Subscription ID - Only Subscription flow
      payMode string
      Pay mode of the subscription
      status string
      Current status of the subscription
      subStatus string
      Status of the subscription payMode
      activationDate string
      Time when the subscription was activated
      vpa string
      Masked vpa for the subscription (only in case of Paymode UPI)
      orderId string
      orderid that has been given for the request
      subsPaymentInstDetails Json string
      subscription payment instrument details
      SubsPaymentInstDetails +
      AttributeDescription
      bankName string
      issuing bank name
      bankLogo string
      issuing bank logo
      cardSchemeLogo string
      logo of the card scheme
      lastFourDigits string
      If paymode is CC/DC and merchant is eligible
      expiryDate string
      expiry date of the card
      cardScheme string
      card scheme like VISA, MASTER, etc.
      bin string
      If paymode is CC/DC and merchant is eligible
      maskedAccountNumber string
      account number in masked form
      ifsc string
      ifsc code
      instrumentStatus string
      status of the instrument (EXPIRED/ ACTIVE/ INACTIVE)
      paymentMode string
      payment mode
      Possible Values : NORMAL/PPI/CC/DC/PPBL/BANK_MANDATE/UPI/UNKNOWN
      ppiType string
      states whether the subscription is having pay mode
      PPI(Wallet) =>Y or NORMAL(Wallet with AddNPay) => N
      Possible Values : Y/N
      savedCardId string
      If paymode is CC/DC and merchant is eligible
      mandateType string
      Possible Value : E_MANDATE / PAPER_MANDATE
      subsLastRetryDone Json string
      last retry done on subscription
      SubsLastRetryDone +
      AttributeDescription
      status string
      status of the retry
      attemptedTime string
      time at which attempted.
      subsNextRetry Json string
      details of next retry that would be done
      SubsNextRetry +
      AttributeDescription
      attemptedTime string
      time at which retry would be attempted
      subsRetryDetails Json string
      details of retries done on subscription
      SubsRetryDetails +
      AttributeDescription
      totalRetryCount string
      total retry counts
      retriesLeft string
      retries available for the subscription
      lastOrderId string
      order id of the last order created
      lastOrderStatus string
      order status of the last order created
      Possible Values :
      FAIL / SUCCESS / PENDING
      lastOrderCreationDate string
      creation time of the last order. Format - yyyy-MM-dd HH:mm:ss.m
      lastOrderAmount string
      amount of the last order
      amountType string
      amountType of subscription
      Possible values : FIX/VARIABLE
      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.
      frequencyUnit string
      frequencyUnit of subscription
      Possible Values : DAY/MONTH/YEAR/WEEK/ONDEMAND/QUARTER/BI_MONTHLY/SEMI_ANNUALLY
      frequency string
      Value of the frequency
      merchantName string
      Merchant Display Name
      expiryDate Date(yyyy-MM-dd HH:mm:ss)
      Expiry Date for the subscription
      createdDate Date (yyyy-MM-dd HH:mm:ss
      Created Date for the subscription
      updatedDate Date (yyyy-MM-dd HH:mm:ss)
      Updated Date for the subscription
      custId string
      Customer Id passed by the merchant
      custEmailId string
      Customer Email passed by the merchant
      custMobileNo string
      Customer Mobile No passed by the merchant
      respCode string
      Responsce Code, only when subscription not created successfully
      respMsg string
      Responsce Message, only when subscription not created successfully
      upfrontTxnAmount string
      Amount deducted at time of subscription creation

      Response Codes and Messages


      codestatusmessage
      3006SUCCESSSUCCESS
      400FAILUREThe request cannot be validated. Please refer to the doc and try again.
      3004FAILURESubscription Not Found.
      3005FAILURESome error occured.
      3045FAILUREBoth orderId and subscriptionId cannot be null.
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/subscription/checkStatus' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"mid":"{mid}","subsId":"67491"},"head":{"tokenType":"AES","signature":"{signature}"}}'