paytm developer docs logoDeveloperDocumentation
search
Your Paytm for business app is working and will keep working beyond March 15th, 2024. Click to know more

POSTFetch Subscription Status API

Use Case

This API provides the status and the details of the subscription being asked.

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.

Body

AttributeDescription
subsId
string
conditional

Subscription ID - Only Subscription flow
Conditional: either use subsId OR (custId & orderId) with mid in request

mid
string
mandatory

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

Example: 216820000002516036253

orderId
string
conditional

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

custId
string
conditional

Customer ID whose subscription is being canceled
Conditional: either use subsId OR (custId & orderId) with mid in request

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimeStamp
string

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

Example: 1588402269

signature
string

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.

Body

AttributeDescription
resultInfo
Object

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

subsId
string

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

payMode
string

Pay mode of the subscription

status
string

Current status of the subscription
 

Possible Values: INIT, ACTIVE, REJECT, IN_AUTHORIZATION, AUTHORIZED, AUTHORIZATION_FAILED, EXPIRED, CLOSED, SUSPENDED

subStatus
string

Status of the subscription payMode

activationDate
string

Time when the subscription was activated

vpa
string

Masked vpa for the subscription

orderId
string

The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”.

 

Example: OREDRID_98765

subsPaymentInstDetails
object

subscription payment instrument details

subsPaymentInstDetails
+
AttributeDescription
bankName
string

Issuing bank name

bankLogo
string

Issuing bank logo

cardSchemeLogo
string

Logo of the card scheme

lastFourDigits
string

If paymode is CC/DC and merchant is eligible

cardScheme
string

Card scheme like VISA, MASTER, etc

bin
string

If paymode is CC/DC and merchant is eligible

maskedAccountNumber
string

Account number in masked form

paymentMode
string

Payment mode
 

Possible Values : CC/DC/PPBL/BANK_MANDATE/UPI/UNKNOWN

mandateType
string

Possible Value: E_MANDATE

subsLastRetryDone
Object

Last retry done on subscription

SubsLastRetryDone
+
AttributeDescription
status
string

status of the retry

attemptedTime
string

time at which last retry was attempted

subsNextRetry
Object

Details of next retry that would be done

SubsNextRetry
+
AttributeDescription
attemptedTime
string

Time at which retry would be attempted

subsRetryDetails
Object


Details of retries done on subscription

SubsRetryDetails
+
AttributeDescription
totalRetryCount
string

Total retry counts

retriesLeft
string

Retries available for the subscription

lastOrderId
string

Order Id of the last order created

lastOrderStatus
string

Order status of the last order created

lastOrderCreationDate
string

Creation time of the last order. Format - yyyy-mm-dd hh:mm:ss

lastOrderAmount
string

Amount of the last order

amountType
string

amountType of subscription
 

Possible Values: FIX, VARIABLE

maxAmount
string

Maximum amount
 

Example: 1000.0

mid
string

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

Example: 216820000002516036253

frequencyUnit
string

frequencyUnit of subscription
 

Possible Values: DAY, MONTH, YEAR, WEEK, QUARTER, BI_MONTHLY, SEMI_ANNUALLY

frequency
string

Value of the frequency

merchantName
string

Merchant Display Name

expiryDate
string

Expiry Date for the subscription. Format - yyyy-mm-dd hh:mm:ss

createdDate
string

Created Date for the subscription. Format - yyyy-mm-dd hh:mm:ss

custId
string

Customer Id passed by the merchant

custEmailId
string

Customer Email passed by the merchant

custMobileNo
string

Customer mobile number passed by the merchant

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.

upfrontTxnAmount
string

Amount deducted at time of subscription creation

upfrontTxnId
string

Txn Id for the payment at time of subscription creation

Response Codes & Messages

resultCoderesultStatusresultMsg
3006SUCCESSSUCCESS
3045FAILUREcustId is mandatory with orderId
3045FAILUREBoth orderId and subscriptionId/LinkId cannot be null
3005FAILURESome error occured
400FAILUREThe request cannot be validated. Please refer to the doc and try again.
3004FAILURESubscription Not Found
400FAILUREMid is invalid
3001FAILURESubscription Id is Invalid
⇾
Staging
Production
https://stage-router.paytm.in/aoa-subscription/api/v2/subscription/checkStatuscopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location 'https://stage-router.paytm.in/aoa-subscription/api/v2/subscription/checkStatus' \
--header 'Content-Type: application/json' \
--data '{"head": {"timestamp": 1672140318157,"signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWJzSWQiOiIxMjMiLCJpc3MiOiJzdXBlcmd3IiwibWlkIjoiMjE2ODIwMDAwMDA4ODU3MTg4ODE1IiwidGltZXN0YW1wIjoiMTY2MzU4OTk3NDg3MCJ9.yIjb7TLb_-iY1jysWgGtzLCooRQrkerqIMZ4HobeERk"},"body": {"mid": "YOUR_MID_HERE","subscriptionId": "10001457","orderId": "","custId": ""}}'



 
copy icon