paytm developer docs logoDeveloperDocumentation
search

Downtime Notification Webhook

Paytm sends a server to server (S2S) response in key-value pair on the configured URL. Downtime notification Webhook response is sent only when we observe the unplanned or planned downtime for the particular payment option.  To configure the URL, please Get in touch.

The sample response of downtime notifications through webhook are mentioned below.

 

Success

{
    "head":{
        "signature":"UohIQi5nUqtx7RCthvEdU0m2e7Ck59ufRpY5TjfW6oa9MB/U1qVNQ1M3qYAN+QUpr8aGSGqyRSzmr2V2RdK13rZlQXwajCVHuX6993ZOqac=",
        "tokenType":"CHECKSUM",
        "clientId":"C11"
    }
    ,"body":{
        "downtimeId":34031,
        "subject":"Degradation observed in processing -KOTAK Visa Credit & Debit Card - Downtime Id - 34031",
        "message":"Entity : Issuing Bank - Card Scheme\nPayment Mode : Credit & Debit Card\nDegradation started at : 05-01-2021 18:04:00\nType of degradation : Severe\nEntity Name : KOTAK-Visa"
    }
}

 

Response Attributes

ATTRIBUTE DESCRIPTION

Head
signature
string		 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.
Example:
UohIQi5nUqtx7RCthvEdU0m2e7Ck59ufRpY5TjfW6oa9MB/U1qVNQ1M3qYAN+QUpr8aGSGqyRSzmr2V2RdK13rZlQXwajCVHuX6993ZOqac=
tokenType
string		 Authentication method.
Example: CHECKSUM
clientId
string		 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

Body
downtimeId
string		 This is a unique id that is issued by Paytm for each downtime event.
Example: 34898
subject
string		 One-liner summary for the downtime/recovery event.
Example: Degradation observed in processing -KOTAK Visa Credit & Debit Card - Downtime Id - 34031
message
object		 Detailed stats for the downtime event
 

Entity

Attribute Description
Entity
 

For which payment instrument we are experiencing the downtime.
Possible values: 

 

if Payment Mode = Credit & Debit Card

  • Card Scheme (E.g. - Visa Cards - All of Visa's cards are down. This can belong to HDFC, ICICI, SBI, etc)
  • Issuing Bank (E.g. HDFC - This means that the entire HDFC down be it Credit/Debit or Visa/Mastercard)
  • Issuing Bank - Card Scheme (E.g. - HDFC-Visa Card This means that only HDFC Visa cards are down for both Credit Card and Debit Card. Mastercard and Rupay card is getting processed normally)
  • Issuing Bank - Card Type (E.g. - HDFC Visa Credit Card - This means that only HDFC Visa Credit cards are down. Mastercard and Debit card is getting processed normally)
  • Issuing Bank - Card Scheme - Card Type (E.g. - HDFC Visa Credit Card - This means that only HDFC Visa Credit cards are down. Mastercard and Debit card is getting processed normally)

if Payment Mode = Netbanking

  • Issuing Bank (E.g - HDFC This means HDFC Net Banking is down )

if Payment Mode = Paytm Wallet

  • WALLET (E.g - WALLET, This mean Paytm wallet is down)

if Payment Mode = UPI

  • NPCI (This means we are experiencing downtime for the UPI payment option)
  • UPI Flow (E.g - UPI Collect, This mean that only UPI Collect flow is down and UPI Intent is getting processed normally)
  • PSP (E.g - Google Pay, This mean that only Google Pay PSP App is down for UPI Intent flow)
  • VPA Family (E.g - @Paytm, This mean that only Paytm VPA is down for UPI Collect flow)
Payment Mode

The payment mode used by customer for transaction.
Possible Values:

  1. Credit Card & Debit Card
  2. Netbanking
  3. Wallet
  4. UPI
Entity Name

This indicates the name of the payment option for which observing downtime occurrence.
Example: KOTAK-Visa
Degradation started at

Timestamp at which downtime is started for the entity.
Example: 21-12-2020 09:51:00
Type of degradation

We have categorized the unplanned downtime as per the severity levels.
*This will be only for the Unplanned downtime event.
Possible values:

 

  • Fluctuation  (When the performance of payment option falls by 45% to 60% compared to their average performance)
  • Moderate (When the performance of payment option falls by 60% to 80% compared to their average performance)
  • Severe  (When the performance of payment option falls by more than 80% compared to their average performance)
Recovery started at

Timestamp at which downtime is resolved for the entity. *This will be only for the recovery notification.
Example: 21-12-2020 09:51:00
Degradation Duration (In Minutes)

The total duration of the downtime occurrence for a particular payment option. *This will be only for the recovery notification.
Example: 12