paytm developer docs logoDeveloperDocumentation
search

POSTPre-notify Status API

Use Case

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

Request Attributes

Content Type : JSON

Head

AttributeDescription
requestTimeStamp
string
optional

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

Example: 1588402269

signature
string
mandatory

AI router 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.

channelId
string
optional

The parameter value identifies the Channel for which the API call is initiated.
 

Possible values: WEB , WAP

Body

AttributeDescription
subscriptionId
string
mandatory

Unique Subscription ID generated by AI router for identifying a subscription transaction

mid
string
mandatory

This is a unique identifier provided to every merchant by AI router.
 

Example: 216820000002516036253

referenceId
string
mandatory

Unique Reference Id for refund transaction which is generated by merchant. Duplicate REFID will be rejected by the AI router.
 

Example: REFID_98765

Response Attributes

Content Type : JSON

Head

AttributeDescription
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 in the API response

resultInfo
+
AttributeDescription
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

subscriptionId
string

Unique Subscription ID generated by AI router for identifying a subscription transaction

txnDate
string

Date of transaction.

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
 

Response Codes & Messages

resultCoderesultStatusresultMsg
3006SUCCESSSUCCESS
3054FAILUREPrenotfiy not found for the given params
3004FAILURESubscription Not Found
3060FAILUREReferenceId is mandatory
3061FAILURESubscriptionId is mandatory
3062FAILUREMerchantId is mandatory
500FAILURESystem Error
3005FAILURESome error occured
⇾
Staging
Production
https://stage-router.paytm.in/aoa-subscription/api/subscription/prenotify/statuscopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-subscription/api/subscription/prenotify/status' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "UMP","version": "v1","requestTimestamp": "1602247805430","channelId": "WEB","signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0VGltZXN0YW1wIjoiMTYwMjI0NzgwNTQzMCIsIm9yZGVySWQiOiJSRU5FVzEzMzE1MTQiLCJpc3MiOiJVTVAiLCJzdWJzY3JpcHRpb25JZCI6Ijk0MTMifQ.I7OL0MtdOhCtoUxjB5VvS0I5vfCmNCeZ-a1dtf9neik"},"body": {"subscriptionId": 10000064,"merchantId": "YOUR_MID_HERE","referenceId": "Billdesk_aoa_UPI_321_52"}}'




 
copy icon