paytm developer docs logoDeveloperDocumentation
search

POSTMandate Form Upload API

Use Case

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

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Version of the API.

Example: v1

requestTimestamp
string
optional

EPOCH timestamp of the time at which request is being sent.
Example: 1588402269

clientId
string
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
mandatory

This parameter identifies whether the API works on checksum authentication.

The value to be sent in tokenType is 'AES' for this API.

signature
string
mandatory

Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum Logic.
Note: Create the signature using the body parameter of the request.

Body

AttributeDescription
mid
string
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
mandatory

Unique subscription Id generated by Paytm for identifying a subscription.

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string

Version of the API passed in the request.
Example: v1

responseTimestamp
string

EPOCH timestamp of the time at which response is being sent.
Example: 1588402269

Body

AttributeDescription
resultInfo
object

This parameter gives the information about the result of the API response

ResultInfo
+
AttributeDescription
code
string

This is the result code corresponding to a particular message and is returned to the merchant. Its maximum length is 64. The different result codes corresponding to this API are mentioned below.

status
string

This parameter indicates the status of API call.

Possible Values: SUCCESS, FAILURE

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

policyForm
string

Policy Form will contain all the credentials required to upload PDF.

uploadUrl
string

URL which will be used to upload signed PDF.

Response Codes & 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.
⇾
Staging
Production
https://securegw-stage.paytm.in/subscription/paper/mandate/uploadUrlcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/subscription/paper/mandate/uploadUrl' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","subscriptionId":"67491"},"head":{"tokenType":"AES","signature":"{signature}"}}'
copy icon