JavaScript is disabled. Some features may not work. You can also read the static version: View text version

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.

Request

Response

API Endpoints

Sandbox Link

GET

https://sandbox.juspay.in/payout/merchant/v1/outage

Production Link

GET

https://api.juspay.in/payout/merchant/v1/outage

                      Basic Auth (copy)
                      *
                      

String

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

string

Pass merchant-id provided by Juspay

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      beneType
                      
                      

String

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

                      category
                      
                      

String

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

Response Body

                      status
                      
                      

String

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

                      bankName
                      
                      

String

Name of the bank (not applicable on UPI_ID)

                      ifscIdentifier
                      
                      

String

First four letters of bank facing downtime (only applicable on ACCOUNT_IFSC)

Example:- e.g., HDFC | ICIC | YESB

                      vpaHandler
                      
                      

String

VPA handle facing downtime (only applicable on UPI_ID)

Example:- e.g., @oksbi

                      bankCode
                      
                      

String

6 digit bank code for the bank facing downtime (not applicable on UPI_ID)

Example:- e.g., 607152 | 607153

                      mode
                      
                      

String

Indicates the payout rail affected by downtime.

Example:- e.g., VISADIRECT | MASTERSEND | IMPS | UPI

                      gateway
                      
                      

String

Name of the gateway facing downtime (in case downtime is limited to particular gateway)