Rotate Institution Secret

This endpoint generates and returns a new secret key for the institution associated with the auth token, invalidating the previous one. It is used to cycle credentials for security purposes.

POST {{host}}/api/v1/institutions/rotate-secret

Response Message Field Description

#	Field Name	Description
1	`success`	Indicates whether the request was successful (`true` for success)
2	`responseCode`	HTTP-like response code (e.g. `200` for success)
3	`responseMessage`	Human-readable result message (e.g. `Success`)
4	`data`	Object containing the institution's updated secret details
4.1	`data.institutionId`	Unique internal ID of the institution
4.2	`data.institutionCode`	Alphanumeric code identifying the institution
4.3	`data.institutionName`	Display name of the institution
4.4	`data.secretKey`	Newly generated secret key (shown only once; must be stored securely)

Sample Response (Success)

{
  "success": true,
  "responseCode": "200",
  "responseMessage": "Success",
  "data": {
    "institutionId": 3,
    "institutionCode": "ACME001",
    "institutionName": "Acme Financial Services",
    "secretKey": "sk_live_xK9mQ2pL7rTv3nHwYd8cZeJf..."
  }
}

Sample Response (Failure)

{
  "success": false,
  "responseCode": "404",
  "responseMessage": "Institution Not Found"
}