search

POSTInitiate Renewal API

Use Case

This API is used to renew a previously created subscription transaction.

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

Super 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
mid
string
mandatory

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

Example: 216820000002516036253

orderId
string
mandatory

It is a unique reference ID for a transaction passed in the transaction request. Order ID should be passed to raise the refund
 

Example: OREDRID_98765

requestType
string
mandatory

This parameter is used to identify the transaction flow.
Its value shall be as mentioned below:
‘RENEW_SUBCRIPTION’ for Renewal
 

subscriptionId
string
mandatory

Unique subscription id generated by Paytm Super Router provided in subscription creation process

txnAmount
Object
optional

The first payment amount to be charged to the customer at the time of subscription creation.
*Only for UPI & e-Mandates paymodes - The txnAmount cannot be greater than the renewalAmount
 

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

TxnAmount
+
AttributeDescription
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

extendInfo
Object
optional

Merchant can pass any order specific information that is required to be passed here

ExtendInfo
+
AttributeDescription
udf1
string
optional

User define parameter 1.

udf2
string
optional

User define parameter 2.

udf3
string
optional

User define parameter 3.

mercUnqRef
string
optional

Merchant's reference text which comes in final response of Process Transaction API from Paytm

comments
string
optional

Comments

debitDate
Date
optional

Functionality to accept a future date for renewal in this param

 

Format : yyyy-MM-dd HH:mm:ss

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimeStamp
string

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

Example: 1588402269

signature
string

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

Body

AttributeDescription
resultInfo
string

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.

txnId
string

This is a unique Paytm transaction ID that is issued by Paytm for each transaction

extraParamsMap
Map

Map for any extra information (in case of error).

Response Codes & Messages

resultCoderesultStatusresultMsg
0SSuccess
1007FMid is mandatory in query parameter
2014FOrderId in the query param doesn't match with the OrderId send in the request
2013FMid in the query param doesn't match with the Mid send in the request
501FInternal System error
500FSystem Error
919FMerchant Not Found
929FInvalid Subscription Details
1104FValidation failed
1102FSomething went down. Please retry again
931FPayment request is already pending in this frequency cycle
928FRetry count for payment request in this cycle has been exhausted
935FSubscription has been already cancelled
3004FSubscription Not Found
1104FThe subscription has already expired
1104FDuplicate Order Id
1104FThis subscription is suspended
1104FTransaction amount cannot be null
905FPayment request amount does not match the Subscription contract
913FPayment request amount is not allowed as per the subscription contract
910FSubscription has been disabled for your merchant account. Please reach out to support teams to enable the same
945FManual renewal is not allowed as subscription has auto renewal preference configured
1104FRenewal request is already pending in this frequency cycle
1103FThe Debit Date is invalid
1105FThe Debit Date is beyond Subscription End Date
3054FPrenotify not found for subscriptionId of this transaction date and amount
3055FThe debit date does not match with the one sent in the notification request
3057FThe debit amount does not match with the one sent in the notification request
3059FPreNotify is not scheduled for the payment request
1104FPayment Request date cannot be for future frequency cycles
1104FPayment Request date is not as per the subscription contract
1104FPayment request is already success in this frequency cycle
Staging
Production
https://stage-router.paytm.in/aoa-subscription/api/subscription/renew?mid={mid}&orderId={orderId}copy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-subscription/api/subscription/renew?mid=YOUR_MID_HERE&orderId=arjunrenew009' \
--header 'Cache-Control: no-cache' \
--header 'Content-Type: application/json' \
--header 'Postman-Token: e56c9dc2-ae89-405b-b48d-ec8211db2e0f' \
--data '{"head": {"clientId": "UMP","version": "v1","requestTimestamp": "1680168061929","channelId": "WEB","tokenType" : "JWT","token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXF1ZXN0VGltZXN0YW1wIjoiMTY4MDE2NDcxNDE5NCIsIm9yZGVySWQiOiJzdWJzMTU0IiwiaXNzIjoiVU1QIiwic3Vic2NyaXB0aW9uSWQiOiIxMDAwMDgwMSIsIm1pZCI6IjIxNjgyMDAwMDAwMjUxNjAzNjI1MyJ9.WXewioZpgzIs0s-Ai93wf3qNhmwmtlIvUaPtPeGx86A"},"body": {"mid": "YOUR_MID_HERE","orderId": "arjunrenew009","txnAmount": {"value": "1","currency": "INR"},"subscriptionId": "10001457","extendInfo": {"udf1": "123","udf2": "23","udf3": "345","mercUnqRef": "123","comments": ""}}}'

 

copy icon