Body
UPI Outage API
This API can be utilized to retrieve the health status of banks and PSPs within the UPI ecosystem. If no request body is provided, the response will contain the health status of the top 15 configured banks and PSPs. If only one of the banks or PSPs is included in the request, the corresponding health status will be returned in the response. If either banks or PSPs are omitted in the request, the default configured health status will be returned in the response.
Use case
When the user lands onto payment checkout screen or bank selection to make a UPI transaction, the Merchant/TPAP(UPI App) can decide to grey out or hide the accounts that cannot serve traffic at that given point by initiating an outage status check right before the transaction starts.
This ensures no technical declines for the customer thus increasing the success rate and lowering the dropouts leading to a better customer experience.
Recommended integration approach
The outage status API can be called at certain interval(preferably in minutes for low traffic or every 3 second for high traffic) and the response can be cached/stored at the service provider’s end.
The stored details can be used to serve the traffic at any given point.
For e.g. the transactions are of the order of 50 per second. There will be one outage status API hit for every 150 transactions and the remaining transactions are served based on that response.
However, the UPI service provider can tweak it based on the customer experience they wish to provide. The API can be consumed before every transaction or every second to be stored at their end.
Default Configurations For Bank Status
>= 70% - UP
>= 40% and <70% - Medium
< 40% - Low
The ranges mentioned above are configurable according to the UPI service provider’s needs.
Request
Response
API Endpoints
Production Link
POST
{{host}}/api/{{uri}}/merchants/outage
Headers
x-merchant-id
String
Will be shared while onboarding.
x-merchant-channel-id
String
Will be shared while onboarding.
x-timestamp
integer
This is an epoch unix timestamp string. For example, 1496918882000. It can be used by us to invalidate older requests.
Content-Type
String
application/json
accept
String
application/json
x-merchant-signature
String
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
Request Schema: application/json
Parameters
banks
Array of String
Optional
The list of IFSCs for which outage has be to found
psps
Array of String
optional
The list of PSP handles for which outage has be to found
iat
*
String
Mandatory
Current Epoch Unix timestamp string. Has to be of 13 digit in Milliseconds
Example: 1496918882000.
udfParameters
Stringified JSON
Optional
Merchant Defined Parameters
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"
200 : Success
Response Body
status
*
String
Mandatory
PSP status of the API
Values: SUCCESS | FAILURE
responseMessage
*
String
Mandatory
PSP response message for the API
Values: Refer Codes Guide in Resource Section.
responseCode
*
String
Mandatory
PSP response code for the API
Values: Refer Codes Guide in Resource Section.
payload
*
String
Mandatory
bankList
*
String
Mandatory
A list of Object which will have bank status of the each IFSC provided in the request body
status
*
String
Mandatory
Success Label of the bank.
UP => Bank is UP
MEDIUM_SUCCESS_RATE => Experiencing Medium SR with the Bank.
LOW_SUCCESS_RATE => Experiencing Low SR with the Bank
STATUS_NOT_AVAILABLE => Not sufficient data
ifsc
*
String
Mandatory
Bank IFSC Value
successRate
*
Decimal String
Mandatory
Bank Success Rate in percentage
merchantChannelId
*
String
Mandatory
Name of merchantChannelId
merchantId
*
String
Mandatory
Name of merchantId
npciStatus
*
String
Mandatory
Values: UP or DOWN
pspList
*
String
Mandatory
A list of Object which will have psp status of the each handle provided in the request body
status
*
String
Mandatory
Success Label of the psp.
UP => Psp is UP
MEDIUM_SUCCESS_RATE => Experiencing Medium SR with the Psp.
LOW_SUCCESS_RATE => Experiencing Low SR with the Psp
STATUS_NOT_AVAILABLE => Not sufficient data
handle
*
String
Mandatory
PSP Handle Value
successRate
*
Decimal String
Mandatory
Psp Success Rate in percentage
udfParameters
Stringified JSON
optional
Merchant Defined Parameters.
Example: "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"