• 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 Upload API

      Checksum required: Yes

      Use Case


      This API can be used to fetch the latest URL to upload the signed mandate form.

      Request Attributes

      API Content format: JSON

      Head

      ATTRIBUTEDESCRIPTIONMandatory
      clientId StringclientId by which key checksum is created, required to validate the checksum.Yes
      version Stringversion of the API. Current version is v1.Yes
      timestamp StringEPOCH timestamp of the time at which request is being sent.Yes
      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.
      policyForm FormPolicy Form will contain all the credentials required to upload PDF .
      uploadUrl StringURL which will be used to upload signed PDF.

      Response Codes and Messages

      codestatusmessage
      3006SUCCESSSUCCESS
      400FAILUREThe request cannot be validated. Please refer to the doc and try again.
      401FAILUREAuthentication Failure.
      3004FAILURESubscription Not Found.
      3005FAILURESome error occured.
      3007FAILUREBank Mandate which is paymode for this subscription is not found.
      3020FAILUREINVALID_MANDATE_STATUS
      3029FAILURECan not generate upload policy because pdf is not created for the mandate request id.

      Endpoints

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

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

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