Outage API
Outage API can provide information regarding health of the beneficiary bank being used by the customer for creating a payout. Merchants can display cautionary messages on UI basis response of outage API.
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Pass merchant-id provided by Juspay
Payment rail on which the details of the beneficiary bank that experience downtimes are desired. Multiple rails of payment separated by comma can be given as inputs.
e.g., “CARD,ACCOUNT_IFSC”
In case no param is passed the API will give outage details across all the payment rails.
Example:- CARD | ACCOUNT_IFSC | UPI_ID
Merchant can pass ‘beneficiary’ to get outage details of beneficiary bank and rail combination or ‘gateway’ to get outage details of gateways.
In case no param is passed the API will give outage details of the gateway as well as the beneficiary bank & rail combinations.
Example:- gateway | beneficiary
Status field indicates impact of downtime on the beneficiary bank. In case of severe impact it will be DOWN, while in case of a moderate or low impact it will be FLUCTUATE
Example:- FLUCTUATE | DOWN
Name of the bank (not applicable on UPI_ID)
First four letters of bank facing downtime (only applicable on ACCOUNT_IFSC)
Example:- e.g., HDFC | ICIC | YESB
VPA handle facing downtime (only applicable on UPI_ID)
Example:- e.g., @oksbi
6 digit bank code for the bank facing downtime (not applicable on UPI_ID)
Example:- e.g., 607152 | 607153
Indicates the payout rail affected by downtime.
Example:- e.g., VISADIRECT | MASTERSEND | IMPS | UPI
Name of the gateway facing downtime (in case downtime is limited to particular gateway)
Have questions?
- Need help? Contact support
- LLM? Read llms.txt