POSTMandate 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
Head
Attribute | Description |
---|---|
version string optional | Version of the API. Example: v1 |
requestTimestamp string optional | EPOCH timestamp of the time at which request is being sent. |
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. |
Body
Attribute | Description |
---|---|
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
Head
Attribute | Description |
---|---|
version string | Version of the API passed in the request. |
responseTimestamp string | EPOCH timestamp of the time at which response is being sent. |
Body
Attribute | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultInfo object | This parameter gives the information about the result of the API response | ||||||||
ResultInfo +
|
Response Codes & Messages
code | status | message |
---|---|---|
3006 | SUCCESS | SUCCESS |
400 | FAILURE | The request cannot be validated. Please refer to the doc and try again. |
401 | FAILURE | Authentication Failure. |
3004 | FAILURE | Subscription Not Found |
3005 | FAILURE | Some error occured. |
3007 | FAILURE | Bank Mandate which is paymode for this subscription is not found. |
3014 | FAILURE | FILE_TOO_LARGE. |
3016 | FAILURE | FILE_NOT_FOUND. |
3020 | FAILURE | INVALID_MANDATE_STATUS. |
3021 | FAILURE | duplicate mandateReqId. |
3030 | FAILURE | Can not generate upload policy because mandate is already notified. |
3031 | FAILURE | No signed document is uploaded for mandate request id. |
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}"}}'