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

      Mandate Form Notify Upload API

      Checksum required: Yes

      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 format: JSON

      Head

      AttributeDESCRIPTIONMandatory
      clientId StringclientId by which key checksum is created, required to validate the checksum.No
      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
      signature StringChecksum string created by using Paytm checksum logic.Yes

      Body

      AttributeDESCRIPTIONMandatory
      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
      subscriptionId StringsubscriptionId created for this mandate.Yes

      Response Attributes

      Head

      ATTRIBUTEDESCRIPTION
      version Stringversion of API as passed in request.
      timestamp StringEPOCH timestamp of the time at which response is being sent.

      Body

      AttributeDescription
      resultInfo ObjectresultInfo object containing result code and message.

      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.

      Endpoints

      Staging: https://securegw-stage.paytm.in/subscription/paper/mandate/notifyUpload

      Production: https://securegw.paytm.in/subscription/paper/mandate/notifyUpload

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