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

      post Cancel Subscription API

      Use Case


      To cancel existing subscription using merchant’s credentials - This can be used by any subscription merchant. Token Type required here is AES

      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
      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"
      tokenType string
      mandatory
      AES – signature is mandatory for checksum validation.
      signature string(108)
      mandatory
      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
      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
      subsId string
      mandatory
      Subscription ID - Only Subscription flow

      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
      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
      mid string(20)
      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
      subsId string
      Subscription ID - Only Subscription flow
      custId string(64)
      Customer ID whose subscription is being cancelled
      createdDate string(15)
      Creation date of subscription
      expiryDate string(15)
      Expiry date of subscription set at the time of creation

      Response Codes and Messages


      codestatusmessage
      200SUCCESSSubscription is unsubscribed successfully. NO CONTENT FOUND (In case where subscription is already cancelled).
      400FAILURESubscription Id field can not be empty. Failed in cancelling subscription. Token not associated with subsId passed in request. MID not associated with subsId passed in request.
      401FAILUREAuthentication Failure.
      4001FAILUREInvalid Subscription start date.
      Invalid Frequency Unit.
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/subscription/cancel' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"mid":"{mid}","subsId":"67491"},"head":{"tokenType":"AES","signature":"{signature}"}}'