Downtime Notification

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.

{
    "head": {
        "tokenType": "CHECKSUM",
        "clientId": "C11",
        "signature": null
    },
    "body": {
        "downtimeId": 58963,
        "mid": "flBRVf09576428416259",
        "currentDowntimeState": {
            "payMethod": "UPI",
            "entity": {
                "entityType": "COLLECT_PSP",
                "payMode": "UPI",
                "General Entity Name": "@upi",
                "psp": {
                    "code": "upi",
                    "name": "@upi"
                }
            },
            "severity": "SEVERE",
            "downtimeId": 58963,
            "downtimeStartTime": "10-05-2021 16:19:00",
            "recoveryTime": null,
            "type": "Unplanned",
            "downtimeState": "ACTIVE"
        }
    }
}

The parameters are briefly described below:

Response Attributes

Head

ATTRIBUTE	DESCRIPTION
signature	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	Authentication method. Example: CHECKSUM
clientId	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

ATTRIBUTE

DESCRIPTION

signature

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

Authentication method.

Example: CHECKSUM

clientId

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

ATTRIBUTE	DESCRIPTION
downtimeId	Unique Id that is issued by Paytm for each downtime event. Example: 34898
mid	Paytm provides MID as a unique identifier to each merchant. For your staging MID, You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383
currentDowntimeState	Downtime stats for the current downtime.
entity	The level of payment instrument where downtime has occurred
entity type	For which payment instrument we are experiencing the downtime. Possible Values: if Paymethod = CARD_PAYMENT CARDSCHEME Example: Visa Cards - All of Visa's cards are down. This can belong to HDFC, ICICI, SBI, etc. ISSUINGBANK Example: HDFC - This means that the entire HDFC down be it Credit/Debit or Visa/Mastercard ISSUINGBANK_CARDSCHEME Example: 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. ISSUINGBANK_CARDTYPE Example: HDFC Visa Credit Card - This means that only HDFC Visa Credit cards are down. Mastercard and Debit card is getting processed normally. ISSUINGBANK_CARDTYPE_CARDSCHEME Example: HDFC Visa Credit Card - This means that only HDFC Visa Credit cards are down. Mastercard and Debit card is getting processed normally. if Paymethod = NET_BANKING ISSUINGBANK - Example: HDFC. This means HDFC Net Banking is down. if Paymethod = BALANCE WALLET - Example: WALLET. This mean Paytm wallet is down. if Paymethod = UPI NPCI - This means we are experiencing downtime for the UPI payment option UPI Flow - Example: UPI Collect. This means that only UPI Collect flow is down and UPI Intent is getting processed normally. PSP - Example: Google Pay. This means that only Google Pay PSP App is down for UPI Intent flow. VPA Family - Example: @Paytm. This means that only Paytm VPA is down for UPI Collect flow.
Code	Indicates the code of the payment option. Possible Values: • AXIS • SBI • BOI **Mapping of bank code and the original name of the entity is available on Link.
Name	Indicates the name of the payment option. • AXIS BANK • STATE BANK OF INDIA • BANK OF INDIA
payMethod	Payment mode used by customers for transactions. Possible Values: • BALANCE • CARD_PAYMENT (For Credit Card and Debit Card ) • NET_BANKING • UPI
severity	It indicates the extent of degradation in performance observed during downtime compared to regular performance. This is available for unplanned downtimes only. There are three different severity levels. Possible Values: FLUCTUATING - 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 **This will be only for the Unplanned downtime.
downtimeStartTime	Timestamp at which downtime is started for the entity. Example: 21-12-2020 09:51:00
recoveryTime	Timestamp at which downtime is resolved for the entity. Example: 21-12-2020 09:51:00 **This will be only for the recovery notification.
type	This indicates the type of downtime for the entity. Possible Values: Planned - When banks take a scheduled break for maintenance purposes. This notification is triggered twice - 24 hours prior to notification and just before planned downtime Unplanned - When we witness a dip in the performance for a particular payment instrument
downtimeState	This indicates the status of downtime. Possible Values: • ACTIVE • CLOSED