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

Attribute	Description
clientId string(3) 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
version string(4) optional	Version of the API. Example: v1
requestTimestamp string(15) optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
tokenType string mandatory	AES – signature is mandatory for checksum validation.
signature string(108) 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.

Body

Attribute	Description
subsId string conditional	Subscription ID - Only Subscription flow Conditional: either use subsId OR (custId & orderId) with mid in request.
mid string(20) mandatory	Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383
custId string(64) conditional	Customer ID whose subscription is being cancelled Conditional: either use subsId OR (custId & orderId) with mid in request
orderid string conditional	The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”. Example: OREDRID_98765 Conditional: either use subsId OR (custId & orderId) with mid in request
linkId string conditional	linkId that has been returned to merchant while creating link based subscription. Either orderId or subsId or linkId is mandatory. Note: Only one active subscription will exist corresponding to linkId

Response Attributes

Content Type : JSON

Head

Attribute	Description
responseTimestamp string(15)	EPOCH timestamp of the time at which response is being sent. Example: 1588402269
tokenType string	AES – signature is mandatory for checksum validation.
clientId string(3)	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
signature string(108)	You should validate the parameter values by verifying the signature comes in the response. It ensures that parameter values not tempered. Signature string can be verified by using Paytm checksum library.

Body

Attribute

Description

resultInfo

object

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

ResultInfo

Attribute	Description
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
resultStatus string	This parameter indicates the status of API call. Possible Values: SUCCESS, FAILURE
resultMsg 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.

subsId

string

Subscription ID - Only Subscription flow

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

Possible Values: INIT, PPBL_PENDING, PPBL_REJECT, NPCI_PENDING, NPCI_REJECT, ACTIVE,
MERCHANT_CANCELLED, USER_CANCELLED, TIMED_OUT, ORDER_CLOSED, CONFIRMED, ISSUING_BANK_CANCELLED, USER_SUSPENDED, MERCHANT_SUSPENDED, PPBL_SUSPENDED, RESUMED

activationDate

string

Time when the subscription was activated

vpa

string

Masked vpa for the subscription (only in case of Paymode UPI)

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

Attribute	Description
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
expiryDate string	Expiry date of the card
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
ifsc string	IFSC code
instrumentStatus string	Status of the instrument (EXPIRED/ ACTIVE/ INACTIVE)
paymentMode string	Payment mode Possible Values : NORMAL/PPI/CC/DC/PPBL/BANK_MANDATE/UPI/UNKNOWN
ppiType string	States whether the subscription is having pay mode PPI(Wallet) =>Y or NORMAL(Wallet with AddNPay) => N Possible Values : Y/N
savedCardId string	If paymode is CC/DC and merchant is eligible
mandateType string	Possible Value: E_MANDATE / PAPER_MANDATE

subsLastRetryDone

object

Last retry done on subscription

SubsLastRetryDone

Attribute	Description
status string	status of the retry
attemptedTime string	time at which last retry was attempted

subsNextRetry

string

Details of next retry that would be done

SubsNextRetry

Attribute	Description
attemptedTime string	Time at which retry would be attempted

subsRetryDetails

object

Details of retries done on subscription

SubsRetryDetails

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

Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation.

Example: INTEGR7769XXXXXX9383

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

updatedDate

string

Updated 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

respCode

string

Responsce Code, only when subscription not created successfully

respMsg

string

Responsce Message, only when subscription not created successfully

upfrontTxnAmount

string

Amount deducted at time of subscription creation

upfrontTxnId

string

Txn Id for the payment at time of subscription creation

pauseStartDate

string

Start date for the paused/suspended state of the subscription (This information shall be shared only for paused subscriptions).
Format - yyyy-mm-dd hh:mm:ss

pauseEndDate

string

End date for the paused/suspended state of the subscription (This information shall be shared only for paused subscriptions).
Format - yyyy-mm-dd hh:mm:ss

Response Codes & Messages

code	status	message
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.
3045	FAILURE	Both orderId and subscriptionId cannot be null.

⇾

Staging

Production

https://securestage.paytmpayments.com/subscription/checkStatus copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securestage.paytmpayments.com/subscription/checkStatus' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","subsId":"67491"},"head":{"tokenType":"AES","signature":"{signature}"}}'