• 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 Mandate Form Notify Upload API

      Use Case


      This API can be used to update PG that the signed mandate form has been uploaded on the S3 location.

      Request Attributes


      API Content Type: JSON

      Head1

      Head

      ATTRIBUTEDESCRIPTION
      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
      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
      tokenType string(AES)
      mandatory
      This parameter identifies whether the API works on checksum authentication. The value to be sent in tokenType is 'AES' for this API and checksum should be sent in relevant parameter of the request.
      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
      subscriptionId string(64)
      mandatory
      Unique subscription id generated by Paytm for identifying a subscription.

      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
      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

      Response Codes and Messages


      codestatusmessage
      3006SUCCESSSUCCESS
      3005FAILURESome error occured.
      3021FAILUREduplicate mandateReqId.
      3016FAILUREFILE_NOT_FOUND.
      3014FAILUREFILE_TOO_LARGE.
      3031FAILURENo signed document is uploaded for mandate request id.
      3030FAILURECan not generate upload policy because mandate is already notified.
      400FAILUREThe request cannot be validated. Please refer to the doc and try again.
      3004FAILURESubscription Not Found
      3007FAILUREBank Mandate which is paymode for this subscription is not found.
      401FAILUREAuthentication Failure.
      3020FAILUREINVALID_MANDATE_STATUS.
      StagingProduction
      REQUESTRESPONSE
      curl -X POST 'https://securegw-stage.paytm.in/subscription/paper/mandate/notifyUpload' \
      --header 'Content-Type: application/json' \
      --data '{"body":{"mid":"{mid}","subscriptionId":"67491"},"head":{"tokenType":"AES","signature":"{signature}"}}'