search

POSTPreNotify CheckStatus API

Use Case

This is to check the status whether notification has been sent or not.

Request Attributes

Content Type : JSON

Head

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

timestamp
string
optional

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

Body

AttributeDescription
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
Either referenceId or paytmReferenceId is Mandatory

paytmReferenceId
string
conditional

Reference Id

Either referenceId or paytmReferenceId is Mandatory

Response Attributes

Content Type : JSON

Head

AttributeDescription
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.
Example: v1

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

txnDate
string

Date on which the debit is intended to happen
Format DD-MM-YYYY HH:MM

Example: 06-11-2020 09:00

txnMessage
string

Reason for debit, with length between 1 to 50 alphanumeric characters.

notificationStatus
string

Whether the notification has been successfully sent
(SUCCESS, FAILURE, PENDING, REVOKED, BLOCKED, CLOSED)

PENDING: In case of UPI, awaiting for terminal state (Transition state)
REVOKED: If prenotification was cancelled by the merchant. in case of SI hub subscription
BLOCKED:  For ONDEMAND case, where the renewal/recurring debit request against this pre-debit notification is in progress (Transition state)
CLOSED: For ONDEMAND case, once payment against this pre-debit notification has been successful or retry counts have exhausted post repeated failures.

notificationStatusCode
string

Status code due to which the notification has failed

notificationStatusMessage
string

Status message

notificationDate
string

Date on which notification has been sent.
Format : DD/MM/YYYY HH:MM

Response Codes & Messages

codestatusmessage
3006SUCCESSSUCCESS
400FAILUREThe request cannot be validated. Please refer to the doc and try again.
401FAILUREAuthentication Failure.
500FAILURESystem Error
3005FAILURESome error occured.
3054FAILUREPrenotify not found for the given params
3055FAILUREInvalid Request

Notification status codes and messages

notificationStatus notification
StatusCode
notificationStatusMessage
SUCCESS 0  
FAILURE U28 Your payment failed as your bank is experiencing issues right now. Please try again after sometime.
FAILURE QB Scheduled payment has already been accepted. You can't perform any action on it
FAILURE UC5 Response validation customer got timed out at remitter bank
FAILURE NU Unable to notify payer for mandate execution
FAILURE UC2 Your payment request was unsuccessful. Please try again.
FAILURE UC1 Response auth validation customer got timed out at payer psp
FAILURE UC3 Your payment request was unsuccessful. Please try again.
FAILURE B3 Your payment request was declined as the transaction is not permitted for this account type.
FAILURE 91 Your request is being processed.
FAILURE QL Your request was unsuccessful as the debit amount is higher than the maximum amount limit kept by your PSP.
FAILURE VA Your request was unsuccessful as the mandate has been revoked.
FAILURE U97 Your payment request was unsuccessful. Please try again.
FAILURE ZH Your request was declined as the UPI address is invalid.
FAILURE VF Your request was declined by the remitter bank due to UMN does not exist. Please contact your remitter bank.
FAILURE U17 Your request was unsuccessful. Please try again later.
FAILURE V1 Invalid mandate execution number
FAILURE XB Your payment request was declined by the remitter bank.
FAILURE QD Your request was unsuccessful as the mandate has expired.
FAILURE U98 Your payment request was unsuccessful. Please try again.
FAILURE XY Your payment request was unsuccessful as the remitter bank is offline. Please try again later.
FAILURE VS Your request was declined due to duplicate request received for your mandate.
FAILURE QC Your request was unsuccessful as the mandate has been revoked.
FAILURE XI Your payment request was unsuccessful as the beneficiary account does not exist.
FAILURE YF Your payment request was declined by the beneficiary bank as the account is blocked or frozen.
FAILURE IR Your payment request was declined by the remitter bank. Please try again later.
FAILURE QN Your request was declined due to duplicate request received for your mandate.
FAILURE QJ Your request was declined by your PSP due to UMN does not exist.
PENDING    
REVOKED
(only for SI)
   
BLOCKED
(for PDN against
which renewal is in progress)
0  
CLOSED
(for PDN against
which renewal is either
successful or retries
have been exhausted)
0  
Staging
Production
https://securegw-stage.paytm.in/subscription/preNotify/statuscopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
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"}}'

 

copy icon