ResponseWrapperCatalogueNotificationListDto
statusstring
Status of the response
Possible values: [SUCCESS, ERROR]
Example:
ERROR/SUCCESSmessagestring
Message describing the response
Example:
Request failed/Request successfulcodeMessagestring
Code message describing the response
Example:
ERR-001/SUC-001data object[]
Array [
codestring
Unique code identifying the notification template.
Example:
BLOCKED_ACCOUNTdescriptionstring
Human-readable description of the notification template.
Example:
Notification sent when an account is blocked.bankCodestring
Code of the bank associated with the notification template.
Example:
BANK001requiredVariablesstring
Comma-separated list of required variables to be used in the notification template.
Example:
_ACCOUNT_NUMBER_,_REASON_]
error object
Detailed information about the error response
codestring
Error code
Example:
ERR-142messagestring
Error message
Example:
Resource not found / Internal server errordetails object[]
List of error details
Array [
codestring
Error code
Example:
ER4001messagestring
Detailed error message
Example:
Invalid inputtargetstring
Target of the error
Example:
username]
suggestionsstring[]
List of suggestions for resolving the error
Example:
["Check the resource ID","Ensure the resource exists"]metaData object
Additional metadata about the error, that could help in debugging
property name*string
Additional metadata about the error, that could help in debugging
Example:
{"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}timestampstring<date-time>
Timestamp of when the response was generated
ResponseWrapperCatalogueNotificationListDto
{
"status": "ERROR/SUCCESS",
"message": "Request failed/Request successful",
"codeMessage": "ERR-001/SUC-001",
"data": [
{
"code": "BLOCKED_ACCOUNT",
"description": "Notification sent when an account is blocked.",
"bankCode": "BANK001",
"requiredVariables": "_ACCOUNT_NUMBER_,_REASON_"
}
],
"error": {
"code": "ERR-142",
"message": "Resource not found / Internal server error",
"details": [
{
"code": "ER4001",
"message": "Invalid input",
"target": "username"
}
],
"suggestions": [
"Check the resource ID",
"Ensure the resource exists"
],
"metaData": {
"requestId": "3c5e4cebf39cbc5b",
"operationId": "66fd4d2ae6b6"
}
},
"timestamp": "2024-07-29T15:51:28.071Z"
}