POSTFetch historical downtime API

Use Case

To fetch the list of downtime events that happened between two dates.

Request Attributes

Content Type : JSON

Head

Attribute	Description
signature string mandatory	This is for the checksum authentication.
tokenType string mandatory	Authentication method. EXAMPLE: CHECKSUM
clientid string 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

Body

Attribute	Description
mid string mandatory	This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MID is available here & production MID will be available once your activation is complete. Example: INTEGR7769XXXXXX9383
paymentModes string optional	The payment mode used by customer for transaction. If the payment mode will be null, we will send the notification for all payment modes. Possible value:* CC, DC, NB, UPI, WALLET
fromTime string mandatory	Include downtime from start date-time. Example: 15-05-2020 10:35:24
toTime string mandatory	Include downtime till the end date-time. Example: 15-05-2020 10:45:24

Response Attributes

Content Type : JSON

Body

Attribute

Description

history

string

A detailed list of entities that were experiencing downtime in the requested time range.

payMethod

string

The payment mode used by customer for transaction.

Possible Value: Paytm Wallet, CARD_PAYMENT (For Credit Card and Debit Card ), NET BANKING, UPI

entityType

string

For which payment instrument we are experiencing the downtime.

EntityType

Attribute	Description
entityType string	For which payment instrument we are experiencing the downtime. Possible value : if Paymethod = CARD_PAYMENT CARDSCHEME (E.g. - Visa Cards - All of Visa's cards are down. This can belong to HDFC, ICICI, SBI, etc) ISSUINGBANK (E.g. HDFC - This means that the entire HDFC down be it Credit/Debit or Visa/Mastercard) ISSUINGBANK_CARDSCHEME (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) ISSUINGBANK_CARDTYPE (E.g. - 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 (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 Paymethod = NETBANKING ISSUINGBANK (E.g - HDFC This means HDFC Net Banking is down ) if Paymethod = Paytm Wallet WALLET (E.g - WALLET, This mean Paytm wallet is down) if Paymethod = 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)
code string	This indicates the code of the payment option. Mapping of bank code and the original name of the entity is available on Link. Possible value:* AXIS, SBI, BOI
name string	This indicates the original name of the payment option. AXIS BANK STATE BANK OF INDIA BANK OF INDIA

severityCycle

string

Severity Cycle

SeverityCycle

Attribute	Description
startTime string	Timestamp at which downtime is started with the particulary severity for the entity. Example : 21-12-2020 09:51:00
endTime string	Timestamp at which downtime is ended with the particulary severity for the entity. Example : 21-12-2020 10:51:00
severity string	We have categorized the unplanned downtime as per the severity levels. This will be only for the Unplanned downtime. 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)

downtimeId

string

This is a unique id that is issued by Paytm for each downtime event.

Example: 34898

downtimeStartTime

string

Timestamp at which downtime is started for the entity.

Example: 21-12-2020 09:51:00

recoveryTime

string

Timestamp at which downtime is resolved for the entity.

Example: 21-12-2020 09:51:00

type

string

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)

Response Codes & Messages

resultCode	resultStatus	resultMsg
00000000	TXN_SUCCESS	Success
00000004	TXN_FAILURE	Illegal parameters
00000005	TXN_FAILURE	Token Invalid/Expired
00000009	TXN_FAILURE	Internal Server error

⇾

Staging

Production

This Api is not hosted on staging environment. copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST \
  https://securegw.paytm.in/downtime-manager/api/paytm/pg/daas/fetch-downtime-recovery-history \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'postman-token: bbf946e0-8df7-55c8-3dd1-77e43116c4f2' \
  -d '{"body":{"mid":"INTEGR77698636129383","fromTime":"2020-11-19T20:18:33.129Z","toTime":"2020-12-20T20:18:33.129Z"},
  "head":{"signature":"5f8agjSRYSaJ9LQ8iQ/cDjv/602fgBRAHBNwLN3DR6S1atPZGuT1QKBcqf6XbSqk2HnSUgrY/s5smr2DMT6THjLLoHYTlph3qm4Us+/68l0="}
 }'