POSTPreNotify CheckStatus API
Use Case
This is to check the status whether notification has been sent or not.
Request Attributes
Head
Attribute | Description |
---|---|
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. |
timestamp string optional | EPOCH timestamp of the time at which response is being sent. |
Body
Attribute | Description |
---|---|
mid string mandatory | Paytm provides MID as a unique identifier to each merchant. Example: INTEGR7769XXXXXX93833 |
subsId string mandatory | Subscription ID - Only Subscription Flow |
referenceId string conditional | Unique reference number, Length <= 32 |
paytmReferenceId string conditional | Reference Id Either referenceId or paytmReferenceId is Mandatory |
Response Attributes
Head
Attribute | Description |
---|---|
clientId string | 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 |
version string | Version of the API passed in the request. |
timestamp 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 +
| |||||||||
txnDate string | Date on which the debit is intended to happen Example: 06-11-2020 09:00 | ||||||||
txnMessage string | Reason for debit, length <= 200 | ||||||||
notificationStatus string | Whether the notification has been successfully sent | ||||||||
notificationStatusCode string | Status code due to which the notification has failed | ||||||||
notificationStatusMessage string | Status message | ||||||||
notificationDate string | Date on which notification has been sent. |
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. |
500 | FAILURE | System Error |
3005 | FAILURE | Some error occured. |
3054 | FAILURE | Prenotify not found for the given params |
3055 | FAILURE | Invalid Request |
curl -X POST 'https://securegw-stage.paytm.in/subscription/preNotify/status' \
-H 'Content-Type: application/json' \
--data-raw '{"head":{"version" : "v1","timestamp" : "",
"signature" : "{signature}","tokenType" : "AES","clientId" : "1234" },"body":{"subsId" : "7268","mid" : "{mid}","referenceId" : "NspPa6464ndCre985T5908985456"}}'