paytm developer docs logoDeveloperDocumentation
search

POSTList Subscriptions API

Use Case

This API is used to display the listing of all subscriptions set up against the users at your end. The subscriptions can be filtered on the basis of subscription status and frequency unit.

Request Attributes

Content Type : JSON

Head

AttributeDescription
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

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.

tokenType
string
mandatory

AES – signature is mandatory for checksum validation.

token
string
mandatory

In case of tokenType SSO Inputs could be : SSO token value.

Body

AttributeDescription
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
mandatory

Customer Id passed by the merchant

subsStatusFilter
array
optional

Status Filter Filtering

frequencyUnit
string
optional

frequencyUnit of subscription.

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

subscriptionId
string(64)
optional

Unique subscription id generated by Paytm for identifying a subscription.

detailRequired
boolean
optional

If passed, result will include all details.

Response Attributes

Content Type : JSON

Head

AttributeDescription
version
string(2)

Version of the API passed in the request.
Example: v1

timestamp
string(15)

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

Body

AttributeDescription
resultInfo
object

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

ResultInfo
+
AttributeDescription
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.
 

subscriptionDetails
object

Details of the subscription

SubscriptionDetails
+
AttributeDescription
merchantName
string

Merchant name

merchantLogo
string

Merchant logo

subscriptionStartDate
string

The start date for subscription

subscriptionEndDate
string

Expiry Date for Subscription

nextRenewalDate
string

Next Renew Date

frequency
string

Multiplier corresponding to frequencyUnit

frequencyUnit
string

Subscription Frequency Unit

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

subscriptionType
string

Subscription Paymode

Possible Values: BALANCE, CREDIT_CARD, DEBIT_CARD, PPBL, BANK_MANDATE, UPI

subscriptionAmount
string

Subscription Amount

subscriptionAmountType
string

Type of subscription amount

Possible Values: FIX, VARIABLE

lastUpdatedDate
string

Contract update timestamp

savedCardId
string

Saved card Id if present

subscriptionId
string

Unique Identifier for Subscription

paymentDetails
string

Details corresponding to last successful payment

PaymentDetails
+
AttributeDescription
lastBilledAmount
string

Last Billed Amount

lastSuccessTxnDate
string

Last Success Transaction Date

lastSuccessOrderId
string

Last Success Order Id

onusMerchant
string

Identifier for onusMerchants

merchantId
string

Unique Identifier for merchant

issuerBankAccNo
string

Bank account number (Present, if paymode is BANK_MANDATE)

issuerBankName
string

Bank Name (Present if paymode is BANK_MANDATE)

issuerBankIfsc
string

Bank IFSC (Present if paymode is BANK_MANDATE)

accountHolderName
string

Account Holder name (Present if paymode is BANK_MANDATE)

accountType
string

Account type (Present if paymode is BANK_MANDATE)

website
string

Website

custId
string

Merchant shared cust Id

industryType
string

Industry Type

ssoId
string

Paytm custId (present if subscription created using loggedIn flow)

retryCount
string

Retry count

graceDays
string

Grace days

channelId
string

ChannelId

serviceId
string

ServiceId

cycleCount
string

Subscription current cycle

status
string

Subscription Status

renewalAmount
string

Subscription renewal amount

upfrontAmount
string

Upfront amount (amount paid when subscription created)

autoRenewal
string

Auto renewal

autoRetry
string

Auto Retry

communicationManager
string

Communication Manager

subsCallbackUrl
string

Callback URL

customerDetails
string

User Paytm details if logged in at time of subscription creation

CustomerContact
+
AttributeDescription
customerName
string

Name of the customer

customerEmail
string

Email Id of the customer

customerMobile
string

Mobile number of the customer

customerId
string

Id of the customer

subsGoodsInfo
string

GoodsInfo

GoodsInfo
+
AttributeDescription
merchantGoodsId
string

Unique Id for the goods item (item no)

merchantShippingId
string

Shipping Id

snapshotUrl
string

Product Image URL

description
string

Description of product

category
string

Category of Product

quantity
string

Quantity ordered

unit
string

Unit of quantity (KG/Litre)

price
string

Price of product

Money
+
AttributeDescription
value
string

This parameter contains the amount to be charged to the customer and can have two places of decimal.
Example: 1.00

currency
string

This parameter indicates the currency in which transaction amount is to be deducted.
Possible Values: INR

ExtendInfo
string

Extended info of goods

ExtendInfo
+
AttributeDescription
udf1
string

User define parameter 1.

udf2
string

User define parameter 2.

udf3
string

User define parameter 3.

mercUnqRef
string

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

comments
string

Comments

subsHistoryDetails
string

Subscription history details

SubscriptionHistoryDetails
+
AttributeDescription
Total Successful Renewal Orders
string

Total Successful Renewal Orders

Total Successful Renewal Amount
string

Total Successful Renewal Amount

Total Renewal Orders
string

Total Renewal Orders

Last renewal date
string

Last renewal date

Last renewal Status
string

Last renewal status

subsPaymentInstDetails
string

Payment instrument details

PaymentInstrumentDetails
+
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

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

umrn
string

If paymode is BANK_MANDATE and merchant is eligible for receiving the umrn no

savedCardId
string

States whether the subscription is having pay mode
PPI(Wallet) =>Y or NORMAL(Wallet with AddNPay) => N

Possible Values : Y/N

mandateType
string

Description needed

Possible Values: E_MANDATE, PAPER_MANDATE

maskedVpa
string

VPA in masked form

merchantSharedCustDetails
string

Shared customer details by merchant

CustomerContact
+
AttributeDescription
customerName
string

Name of the customer

customerEmail
string

Email Id of the customer

customerMobile
string

Mobile number of the customer

customerId
string

Id of the customer

maxAmount
string

Subscription Max Amoun

subscriptionCreateDate
string

Subscription created date

Response Codes & Messages

codestatusmessage
3006 SUCCESS SUCCESS
200 SUCCESS NO CONTENT FOUND
400 FAILURE The request cannot be validated. Please refer to the doc and try again
500 FAILURE System Error
⇾
Staging
Production
https://securestage.paytmpayments.com/subscription/list/allcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securestage.paytmpayments.com/subscription/list/all' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","custId":"CUST_001"},"head":{"tokenType":"AES","signature":"{signature}"}}'
copy icon