Skip to main content
GET
/
payout
/
v1
/
incidents
Get Incidents
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/incidents \
  --header 'Authorization: <authorization>'
"{\n    \"status\": \"SUCCESS\",\n    \"subCode\": \"200\",\n    \"message\": \"List of incidents retrieved\",\n    \"data\": {\n        \"incidents\": [\n            {\n                \"id\": 214711,\n                \"type\": \"BENEFICIARY\",\n                \"entity\": \"BANK\",\n                \"mode\": \"IMPS\",\n                \"createdAt\": \"2022-01-05 00:48:54\",\n                \"resolvedAt\": \"2022-01-05 00:53:24\",\n                \"isScheduled\": false,\n                \"isResolved\": true,\n                \"impact\": \"LOW\",\n                \"entityName\": \"City union bank\",\n                \"entityCode\": \"CIUB\"\n            },\n            {\n                \"id\": 214710,\n                \"type\": \"BENEFICIARY\",\n                \"entity\": \"BANK\",\n                \"mode\": \"IMPS\",\n                \"createdAt\": \"2022-01-05 00:43:24\",\n                \"resolvedAt\": \"2022-01-05 00:45:24\",\n                \"isScheduled\": false,\n                \"isResolved\": true,\n                \"impact\": \"LOW\",\n                \"entityName\": \"City union bank\",\n                \"entityCode\": \"CIUB\"\n            }\n        ]\n    }\n}"
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
StatusSub CodeMessage
SUCCESS200List of incidents retrieved
ERROR403Token is not valid
ERROR403IP Not Whitelisted
ERROR403APIs not enabled. Please fill out the Support Form
ERROR412Token missing in the request
ERROR422Status is invalid
ERROR422startTime should be less than or equal to EndTime.
ERROR422Maximum time difference can be up to 7 days and startTime should be within 90 days from now.
ERROR422startTime should be of the format yyyy-mm-dd
hh:mm:ss
ERROR422endTime should be of the format yyyy-mm-dd
hh:mm:ss
ERROR520Unknown error occurred!

Headers

ā€‹
Authorization
string
required

Bearer auth token

Query Parameters

ā€‹
status
string

Incident status - RESOLVED/UNRESOLVED/ALL are the allowed values Default value is UNRESOLVED if not provided

ā€‹
startTime string
string

Start Time for the desired period. Format yyyy-mm-dd hh:mm:ss

ā€‹
endTime string
string

End Time for the desired period. Format yyyy-mm-dd hh:mm:ss. Default values are current day start Time(00:00:00) and end Time(23:59:59) if not provided.

ā€‹
entityCode string
string

Code for the entity(BANK) on which the incidents are created.

Response

200

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"List of incidents retrieved"

ā€‹
data
object