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

      Fetch Subscription Status API

      Checksum required: Yes

      Use Case


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

      Request Attributes

      API Content format: JSON

      Head

      AttributeDESCRIPTIONMandatory
      version Stringversion of the API. Current version is v1.No
      timestamp StringEPOCH timestamp of the time at which request is being sent.No
      tokenType StringAES (As Checksum authentication works on this API , tokenType need to be sent as AES).Yes
      clientId StringclientId by which key checksum is created, required to validate the checksum.No
      signature StringChecksum string created by using Paytm checksum logic.Conditional
      (if tokenType is AES then mandatory)
      token Stringtoken of the user.Conditional

      Body

      AttributeDESCRIPTIONMandatory
      subsId Stringsubscription ID that has been returned to the merchant/user.Yes
      mid StringThis 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
      custId Stringmerchant provided cust id.Yes

      Response Attributes

      Head

      AttributeDESCRIPTIONMandatory
      timestamp StringEPOCH timestamp of the time at which request is being sent.No
      tokenType StringAES (As Checksum authentication works on this API , tokenType need to be sent as AES).Yes
      clientId StringclientId by which key checksum is created, required to validate the checksum.No
      signature StringChecksum string created by using Paytm checksum logic.Conditional
      (if tokenType is AES then mandatory)

      Body

      AttributeDESCRIPTIONMandatory
      subsId StringSubscription id that has been created for the request.Yes
      payMode StringPay mode of the subscriptionYes
      status StringCurrent status of the subscriptionYes
      subStatus StringStatus of the subscription payModeConditional
      activationDate StringTime when the subscription was activatedConditional

      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.

      Endpoints

      Staging: https://securegw-stage.paytm.in/subscription/checkStatus

      Production: https://securegw.paytm.in/subscription/checkStatus

      Request CodeResponse JSON
      curl -X POST 'https://securegw-stage.paytm.in/subscription/checkStatus' --header 'Content-Type: application/json' --data '{"body":{"mid":"{mid}","subsId":"{subscription-id}","custId":"{customer-id}"},"head":{"tokenType":"AES","signature":"{signature}"}}'