paytm developer docs logoDeveloperDocumentation
search

Subscription Status

Paytm sends a server to server (S2S) response in key value pair on the configured URL. Subscription Status Webhook response is sent only when subscription has been authorized/cancelled/activated by the user. To configure the URL, please Get in touch.

The sample response of different payment sources are mentioned below.

Success

[PPITYPE] => Y
[BANKNAME] => WALLET
[PAYMENTMODE] => PPI
[CUSTID] => CUST_001
[MID] => INTEGR7769XXXXXX9383
[EXPIRYDATE] => 2020-09-25 00:00:00
[UPDATEDDATE] => 2020-09-11 13:07:49
[CUSTMOBILE] => 7777777777
[FREQUENCYUNIT] => MONTH
[MAXAMOUNT] => 1000.0
[ORDERID] => ORDERID_98765
[CREATEDDATE] => 2020-09-11 13:07:26
[UPFRONTTXNAMOUNT] => 0.00
[STATUS] => ACTIVE
[AMOUNTTYPE] => VARIABLE
[MERCHANTNAME] => TEST INTEGRATION 5
[CHECKSUMHASH] => 0v+fpl8eseCsIgDR5fvaSb1gpnHK8sPN1NtA5CV5WzEtPtM/oCUm7xujQhn8RpSmuUXfCIjvX2n0ziQyPPAWkeEA7LAGiAbHGVdbzPKQuqM=
[SUBS_ID] => 102771
[CUSTEMAILID] => customer@example.com

Note: All the response codes of the transaction are available here.

The parameters are briefly described below.

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID
string		 OrderId passed in the request
Example: OREDRID_98765
MID
string		 Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
PAYMENTMODE
string		 Payment Mode used in payment
Example: PPI
STATUS
string		 This parameter indicates the status of API call.
Example: TXN_SUCCESS
BANKNAME
string		 Bank Name used in payment
Example: WALLET
CHECKSUMHASH
string		 Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
CUSTID
string		 Paytm User ID in case user is logged in via Paytm credentials. Else this would mention the cust ID if passed by the merchant.
Example: CUST_001
EXPIRYDATE
string		 Date when subscription will expire Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-19 00:00:00
UPDATEDDATE
string		 Update Date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:32
FREQUENCYUNIT
string		 This is interval cycle
Example: MONTH
MAXAMOUNT
string		 Maximum amount that can be deducted in a subscription request
Example: 1000.0
CREATEDDATE
string		 Subscription create date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:11
UPFRONTTXNAMOUNT
string		 Upfront amount
Example: 0.005
AMOUNTTYPE
string		 Type of Subscription Amount
Example: FIX, VARIABLE
MERCHANTNAME
string		 Merchant Name
Example: TEST INTEGRATION 5
SUBS_ID
string		 SubscriptionId created for this mandate.
Example: 65253
PPITYPE
string		 Only for Wallet
Example: Y
CUSTMOBILE
string		 Customer Mobile
Example: 7777777777
CUSTEMAILID
string		 Customer Email ID
Example: customer@example.com
FREQUENCY
string		 Frequency(Related to Recurring Cycle)
Example: Day

Success

[CARDLASTFOURDIGITS] => 1111
[BANKNAME] => JPMorgan Chase Bank
[BANKLOGO] => https://pgpqa-static1.paytm.com/native/bank/JPMC.png
[PAYMENTMODE] => CC
[CUSTID] => CUST_001
[CARDSCHEMELOGO] => https://pgpqa-static2.paytm.com/native/card/VISA.png
[MID] => INTEGR7769XXXXXX9383
[EXPIRYDATE] => 2020-09-25 00:00:00
[UPDATEDDATE] => 2020-09-11 16:01:17
[FREQUENCYUNIT] => MONTH
[MAXAMOUNT] => 1000.0
[ORDERID] => ORDERID_98765
[CREATEDDATE] => 2020-09-11 16:01:02
[CARDEXPIRYDATE] => 022041
[UPFRONTTXNAMOUNT] => 0.00
[STATUS] => ACTIVE
[AMOUNTTYPE] => VARIABLE
[CARDBIN] => 411111
[MERCHANTNAME] => TEST INTEGRATION 5
[INSTRUMENTSTATUS] => ACTIVE
[CHECKSUMHASH] => Srt7aoaNVh0LaATgkD6OAoIr2KyKb8MeEWcmC4+wamEHPfK4bF5x6ZNHuRjKevUaXBYwRd5HU97w4dpdWsQqlcUW6qSc9M+SPKE36wmiSfo=
[SUBS_ID] => 102889
[CARDSCHEME] => VISA
[CUSTMOBILE] => 7777777777
[CUSTEMAILID]  => customer@example.com

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID
string		 OrderId passed in the request
Example: OREDRID_98765
MID
string		 Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
PAYMENTMODE
string		 Payment Mode used in payment
Example: CC
STATUS
string		 This parameter indicates the status of API call.
Example: TXN_SUCCESS
BANKNAME
string		 Bank Name used in payment
Example: JPMorgan Chase Bank
BANKLOGO
string		 Bank Logo
Example: https://pgpqa-static1.paytm.com/native/bank/ICICI.png
CHECKSUMHASH
string		 Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
CUSTID
string		 Paytm User ID in case user is logged in via Paytm credentials. Else this would mention the cust ID if passed by the merchant.
Example: CUST_001
CARDSCHEME
string		 Card Scheme - Only for Credit/Debit Card
Example: VISA, MASTER
CARDSCHEMELOGO
string		 Card Scheme Logo
Example: https://pgpqa-static1.paytm.com/native/card/VISA.png
EXPIRYDATE
string		 Date when subscription will expire Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-19 00:00:00
UPDATEDDATE
string		 Update Date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:32
FREQUENCYUNIT
string		 This is interval cycle
Example: MONTH
MAXAMOUNT
string		 Maximum amount that can be deducted in a subscription request
Example: 1000.0
CREATEDDATE
string		 Subscription create date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:11
CARDEXPIRYDATE
string		 Card Expiry Format: MMYYYY - Only for Credit/Debit Card
Example: 122025
UPFRONTTXNAMOUNT
string		 Upfront amount
Example: 0.005
AMOUNTTYPE
string		 Type of Subscription Amount
Example: FIX, VARIABLE
MERCHANTNAME
string		 Merchant Name
Example: TEST INTEGRATION 5
INSTRUMENTSTATUS
string		 Status of instruments
Example: ACTIVE
SUBS_ID
string		 SubscriptionId created for this mandate.
Example: 65253
CUSTMOBILE
string		 Customer Mobile
Example: 7777777777
CUSTEMAILID
string		 Customer Email ID
Example: customer@example.com
FREQUENCY
string		 Frequency(Related to Recurring Cycle)
Example: Day
CARDLASTFOURDIGITS
string		 Card Last Four Digits
Example: 1111
CARDBIN
string		 Card Bin Number
Example: 411111
SAVEDCARDID
string		 Saved Card ID
Example: 1159333509

Success

[CARDLASTFOURDIGITS] => 1111
[BANKNAME] => JPMorgan Chase Bank
[BANKLOGO] => https://pgpqa-static1.paytm.com/native/bank/JPMC.png
[PAYMENTMODE] => CC
[CUSTID] => CUST_001
[CARDSCHEMELOGO] => https://pgpqa-static4.paytm.com/native/card/VISA.png
[MID] => INTEGR7769XXXXXX9383
[EXPIRYDATE] => 2020-09-25 00:00:00
[UPDATEDDATE] => 2020-09-11 16:14:58
[FREQUENCYUNIT] => MONTH
[MAXAMOUNT] => 1000.0
[ORDERID] => ORDERID_98765
[CREATEDDATE] => 2020-09-11 16:13:49
[CARDEXPIRYDATE] => 022041
[UPFRONTTXNAMOUNT] => 0.00
[STATUS] => ACTIVE
[AMOUNTTYPE] => VARIABLE
[CARDBIN] => 411111
[MERCHANTNAME] => TEST INTEGRATION 5
[INSTRUMENTSTATUS] => ACTIVE
[CHECKSUMHASH] => 6zS7debzOy+srQBUPqfFuDl8sAm8iL95WsqcT206DehEYHJ7f+JBcGAqkl1ekozsx9wWJMTanGLpTc7HfvXHPhyUc7otX/lMl88V6QGEX64=
[SUBS_ID] => 102909
[CARDSCHEME] => VISA
[CUSTMOBILE] => 7777777777
[CUSTEMAILID]  => customer@example.com

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID
string		 OrderId passed in the request
Example: OREDRID_98765
MID
string		 Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
PAYMENTMODE
string		 Payment Mode used in payment
Example: CC
STATUS
string		 This parameter indicates the status of API call.
Example: TXN_SUCCESS
BANKNAME
string		 Bank Name used in payment
Example: JPMorgan Chase Bank
BANKLOGO
string		 Bank Logo
Example: https://pgpqa-static1.paytm.com/native/bank/ICICI.png
CHECKSUMHASH
string		 Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
CUSTID
string		 Paytm User ID in case user is logged in via Paytm credentials. Else this would mention the cust ID if passed by the merchant.
Example: CUST_001
CARDSCHEME
string		 Card Scheme - Only for Credit/Debit Card
Example: VISA, MASTER
CARDSCHEMELOGO
string		 Card Scheme Logo
Example: https://pgpqa-static1.paytm.com/native/card/VISA.png
EXPIRYDATE
string		 Date when subscription will expire Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-19 00:00:00
UPDATEDDATE
string		 Update Date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:32
FREQUENCYUNIT
string		 This is interval cycle
Example: MONTH
MAXAMOUNT
string		 Maximum amount that can be deducted in a subscription request
Example: 1000.0
CREATEDDATE
string		 Subscription create date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:11
CARDEXPIRYDATE
string		 Card Expiry Format: MMYYYY - Only for Credit/Debit Card
Example: 122025
UPFRONTTXNAMOUNT
string		 Upfront amount
Example: 0.005
AMOUNTTYPE
string		 Type of Subscription Amount
Example: FIX, VARIABLE
MERCHANTNAME
string		 Merchant Name
Example: TEST INTEGRATION 5
INSTRUMENTSTATUS
string		 Status of instruments
Example: ACTIVE
SUBS_ID
string		 SubscriptionId created for this mandate.
Example: 65253
CUSTMOBILE
string		 Customer Mobile
Example: 7777777777
CUSTEMAILID
string		 Customer Email ID
Example: customer@example.com
FREQUENCY
string		 Frequency(Related to Recurring Cycle)
Example: Day
CARDLASTFOURDIGITS
string		 Card Last Four Digits
Example: 1111
CARDBIN
string		 Card Bin Number
Example: 411111
SAVEDCARDID
string		 Saved Card ID
Example: 1159333509

Success

[BANKNAME] => Paytm Payments Bank Ltd
[BANKLOGO] => https://pgpqa-static3.paytm.com/native/bank/PPBL.png
[PAYMENTMODE] => BANK_MANDATE
[CUSTID] => CUST_001
[MID] => INTEGR7769XXXXXX9383
[EXPIRYDATE] => 2020-09-25 00:00:00
[UPDATEDDATE] => 2020-09-11 16:06:34
[FREQUENCYUNIT] => MONTH
[MAXAMOUNT] => 1000.0
[IFSC] => PYTM0123456
[ORDERID] => ORDERID_98765
[CREATEDDATE] => 2020-09-11 16:02:25
[UPFRONTTXNAMOUNT] => 0.00
[STATUS] => AUTHORIZED
[MASKEDACCOUNTNUMBER] => XXXXXX7777
[AMOUNTTYPE] => VARIABLE
[MERCHANTNAME] => TEST INTEGRATION 5
[MANDATETYPE] => E_MANDATE
[CHECKSUMHASH] => OPFBNvPjBL7esTDs3TD71Sp0jgKwEDcv+ALakiX3ahHLFYYTUAIWlH5hNPrlLRtTgJFUVpBDNjEPyUKRQfor77lSdJF8c3JUtNg/wuu9Ekw=
[SUBS_ID] => 102893
[SUBSTATUS] => NPCI_PENDING

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID
string		 OrderId passed in the request
Example: OREDRID_98765
MID
string		 Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
PAYMENTMODE
string		 Payment Mode used in payment
Example: BANK_MANDATE
STATUS
string		 This parameter indicates the status of API call.
Example: TXN_SUCCESS
BANKNAME
string		 Bank Name used in payment
Example: Paytm Payments Bank Ltd
BANKLOGO
string		 Bank Logo
Example: https://pgpqa-static2.paytm.com/native/bank/PPBL.png
CHECKSUMHASH
string		 Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
CUSTID
string		 Paytm User ID in case user is logged in via Paytm credentials. Else this would mention the cust ID if passed by the merchant.
Example: CUST_001
EXPIRYDATE
string		 Date when subscription will expire Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-19 00:00:00
UPDATEDDATE
string		 Update Date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:32
FREQUENCYUNIT
string		 This is interval cycle
Example: MONTH
MAXAMOUNT
string		 Maximum amount that can be deducted in a subscription request
Example: 1000.0
CREATEDDATE
string		 Subscription create date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:11
UPFRONTTXNAMOUNT
string		 Upfront amount
Example: 0.005
AMOUNTTYPE
string		 Type of Subscription Amount
Example: FIX, VARIABLE
MERCHANTNAME
string		 Merchant Name
Example: TEST INTEGRATION 5
SUBS_ID
string		 SubscriptionId created for this mandate.
Example: 65253
IFSC
string		 Bank IFSC Code - Only for Bank Mandate
Example: PYTM0123456
MASKEDACCOUNTNUMBER
string		 Masked Account Number - Only for Bank Mandate
Example: XXXXXXXX7777
MANDATETYPE
string		 Type of Mandate - Only for Bank Mandate
Example: E_MANDATE
SUBSTATUS
string		 Sub Status - Only for Bank Mandate
Example: NPCI_PENDING
CUSTMOBILE
string		 Customer Mobile
Example: 7777777777
CUSTEMAILID
string		 Customer Email ID
Example: customer@example.com
FREQUENCY
string		 Frequency(Related to Recurring Cycle)
Example: Day
ACTIVATIONDATE Date of Activation - Only for Bank Mandate
Example: 2020-05-06 20:43:13

Success

[CARDLASTFOURDIGITS] => 7642
[BANKNAME] => ICICI Bank
[BANKLOGO] => https://pgpqa-static2.paytm.com/native/bank/ICICI.png
[PAYMENTMODE] => DC
[CUSTID] => CUST_001
[CARDSCHEMELOGO] => https://pgpqa-static2.paytm.com/native/card/VISA.png
[MID] => INTEGR7769XXXXXX9383
[EXPIRYDATE] => 2020-09-25 00:00:00
[UPDATEDDATE] => 2020-09-11 16:31:21
[FREQUENCYUNIT] => MONTH
[MAXAMOUNT] => 1000.0
[ORDERID] => ORDERID_98765
[CREATEDDATE] => 2020-09-11 16:16:49
[CARDEXPIRYDATE] => 052022
[UPFRONTTXNAMOUNT] => 0.00
[STATUS] => ACTIVE
[AMOUNTTYPE] => VARIABLE
[CARDBIN] => 41806
[MERCHANTNAME] => TEST INTEGRATION 5
[INSTRUMENTSTATUS] => ACTIVE
[CHECKSUMHASH] => ctNJ124KcOq72H2btza02cSUl2Q38ZqRI694/uaEKWJPmG3dOPPuaKrbuLfklp1A5Q8p9nofze+JrPSNT/uJc4h2J3+gtfhjcGV7H6xxLoM=
[SUBS_ID] => 102911
[CARDSCHEME] => VISA
[CUSTMOBILE] => 7777777777
[CUSTEMAILID]  => customer@example.com

Note: All the response codes of the transaction are available here.

The parameters are briefly described below:

Response Attributes

ATTRIBUTE DESCRIPTION
ORDERID
string		 OrderId passed in the request
Example: OREDRID_98765
MID
string		 Merchant ID passed in the request
Example: INTEGR7769XXXXXX9383
PAYMENTMODE
string		 Payment Mode used in payment
Example: DC
STATUS
string		 This parameter indicates the status of API call.
Example: TXN_SUCCESS
BANKNAME
string		 Bank Name used in payment
Example:ICICI Bank
BANKLOGO
string		 Bank Logo
Example: https://pgpqa-static1.paytm.com/native/bank/ICICI.png
CHECKSUMHASH
string		 Paytm validates the parameter values by verifying the signature comes in the request. It ensures that parameter values are not tempered. Signature string can be created by using Paytm checksum library.
Example:
y5Tn02QKOQdhyYKK+uHHgNIIZOjC/XXXXjSPQRBNSrcP6DR3ejFuQ4+kQi0a8KX2txJCnQkTnUxtJhM6jImU8FU+E1GlSSK5VjMLsSm/R6w=
CUSTID
string		 Paytm User ID in case user is logged in via Paytm credentials. Else this would mention the cust ID if passed by the merchant.
Example: CUST_001
CARDSCHEME
string		 Card Scheme - Only for Credit/Debit Card
Example: VISA, MASTER
CARDSCHEMELOGO
string		 Card Scheme Logo
Example: https://pgpqa-static1.paytm.com/native/card/VISA.png
EXPIRYDATE
string		 Date when subscription will expire Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-19 00:00:00
UPDATEDDATE
string		 Update Date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:32
FREQUENCYUNIT
string		 This is interval cycle
Example: MONTH
MAXAMOUNT
string		 Maximum amount that can be deducted in a subscription request
Example: 1000.0
CREATEDDATE
string		 Subscription create date Format: YYYY-MM-DD HH:ii:ss
Example: 2020-05-05 10:00:11
CARDEXPIRYDATE
string		 Card Expiry Format: MMYYYY - Only for Credit/Debit Card
Example: 122025
UPFRONTTXNAMOUNT
string		 Upfront amount
Example: 0.005
AMOUNTTYPE
string		 Type of Subscription Amount
Example: FIX, VARIABLE
MERCHANTNAME
string		 Merchant Name
Example: TEST INTEGRATION 5
INSTRUMENTSTATUS
string		 Status of instruments
Example: ACTIVE
SUBS_ID
string		 SubscriptionId created for this mandate.
Example: 65253
CUSTMOBILE
string		 Customer Mobile
Example: 7777777777
CUSTEMAILID
string		 Customer Email ID
Example: customer@example.com
FREQUENCY
string		 Frequency(Related to Recurring Cycle)
Example: Day
CARDLASTFOURDIGITS
string		 Card Last Four Digits
Example: 7642
CARDBIN
string		 Card Bin Number
Example: 401806
SAVEDCARDID
string		 Saved Card ID
Example:1159333509