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