POSTInitiate Pre-notify API

Use Case

This is an asynchronous API to pre-notify users about the debit of the subscription.

Request Attributes

Content Type : JSON

Head

Attribute	Description
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

Attribute

Description

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

txnDate

string

mandatory

Date and Time of transaction.

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

txnAmount

Object

mandatory

The first payment amount to be charged to the customer at the time of subscription creation.

Note: Only for UPI & e-Mandates paymodes - The txnAmount cannot be greater than the renewalAmount

Example: {"value" : "1.00", "currency" : "INR"}

TxnAmount

Attribute	Description
value string mandatory	This parameter contains the amount to be charged to the customer and can have two places of decimal. Example: 1.00
currency string mandatory	This parameter indicates the currency in which transaction amount is to be deducted. Possible Values: INR

txnMessage

string

mandatory

Transaction message

invoiceDisplayNo

string

optional

Invoice No

Response Attributes

Content Type : JSON

Head

Attribute	Description
responseTimeStamp string	EPOCH timestamp of the time at which response is being sent. Example: 1588402269

Body

Attribute

Description

resultInfo

object

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

resultInfo

Attribute	Description
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

Response Codes & Messages

resultCode	resultStatus	resultMsg
3006	SUCCESS	SUCCESS
400	FAILURE	The request cannot be validated. Please refer to the doc and try again.
3004	FAILURE	Subscription Not Found
3005	FAILURE	Some error occured
405	FAILURE	Failure in xml parsing
3013	FAILURE	Duplicate Upload Confirmation Request

⇾

Staging

Production

https://stage-router.paytm.com/aoa-subscription/api/subscription/prenotify/send copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl --location 'https://stage-router.paytm.in/aoa-subscription/api/subscription/prenotify/send' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "UMP","version": "v1","requestTimestamp": "1684839061233","channelId": "WEB","tokenType": "AES","signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0VGltZXN0YW1wIjoiMTY4MDE2Nzc4MjE5OSIsImlzcyI6IlVNUCIsInN1YnNJZCI6MTAwMDA4MDIsIm1pZCI6IjIxNjgyMDAwMDAwMjUxNjAzNjI1MyIsInR4bkFtb3VudCI6MiwidHhuRGF0ZSI6IjMwLTAzLTIwMjMiLCJ0eG5NZXNzYWdlIjoiQXJqdW4gcmVuZXcgdGVzdGluZyIsInJlZmVyZW5jZUlkIjoiQmlsbGRlc2tfYW9hX1VQSV8zMjFfMjIiLCJpbnZvaWNlRGlzcGxheU5vIjoiMTIwMDkxMjE2MTIzMjEwMSJ9.34bjElMmTEw0FM1ObJRJ_Dnr3Eb-nyJvApKuLnilD2I"},"body": {"subscriptionId": 10001435,"mid": "YOUR_MID_HERE","txnAmount": 1,"txnDate": "24-05-2023","txnMessage": "Arjun renew testing","referenceId": "Paytm_Arjun_732sdfds","invoiceDisplayNo": "1200912161232101"}}'