Body
List Outages [Deprecated]
Error
Please use the Payment Methods API
with this query param - options.add_outage=true to get a list of outages.
This API will return list of outages with banks and payment gateways. At this point, we only return the Scheduled downtimes that are announced by the Bank. You may use this to suggest alternative payment methods to your customers during the checkout process.
An example checkout screen with downtime info:
Note
The API will contain the current outages and those in the near future as well. Please check the start time & end time to show only the outages that are currently ongoing.
Request
Response
API Endpoints
Sandbox Link
GET
https://sandbox.juspay.in/txns/outages
Production Link
GET
https://api.juspay.in/txns/outages
Authorization Header
Basic Auth
*
Base64 Encoded Username:Password
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
Content-Type
*
String
Mandatory
application/x-www-form-urlencoded
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.
Warning
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
Parameters
id
string
Outage ID generated by JusPay.
object
string
Object type of entity, in this case it’ll be outage.
scope
string
Scope of the outage, one of BANK or GATEWAY. If GATEWAY, then all the payment methods supported by the gateway will be impacted. If BANK, then the issue pertains only to the bank.
gateway
string
Will be present only if the scope is GATEWAY. All the payment methods pertaining to the GATEWAY will be impacted. You can mitigate this risk by having multiple gateways for each of the payment methods. The probability that two gateways will be down simulateneously is extremely low.
bank
string
Will be present only if the scope is BANK.
payment_method_type
string
Will be present only if the scope is BANK. One of NB or CARD. If NB, then NetBanking is impacted. If CARD, then cards issued by the bank will not work.
start_time
string
Indicates the start time of the outage event.
end_time
string
Indicates the outage completion time.
description
string
description
200 : Success
Response Body
object
string
list
count
integer
2
offset
integer
total
integer
2
list
Array of objects
id
String
object
String
scope
String
start_time
String
end_time
String
description
String
gateway
String
Have questions?
- Need help? Contact support
- LLM? Read llms.txt