ResponseWrapperReceiptDto
Generic API response wrapper
statusstring
Response status
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 ReceiptDto[]
Array [
receiptstring<byte>
Array of bytes representing the receipt
]
error object
Details of any error that occurred
codestring
Error code
Example:
ERR-142messagestring
Human-readable error message
Example:
Resource not founddetails object[]
List of error details
Array [
codestring
Specific error code
Example:
ER4001messagestring
What went wrong
Example:
Invalid inputtargetstring
Field that caused the issue
Example:
username]
suggestionsstring[]
Suggested fixes
Example:
["Check the resource ID","Ensure the resource exists"]metaData object
Extra metadata to help debugging
property name*string
timestampstring<date-time>
Timestamp of when the response was generated
Example:
22024-10-14T14:28:11.284+01:00ResponseWrapperReceiptDto
{
"status": "ERROR/SUCCESS",
"message": "Request failed/Request successful",
"codeMessage": "ERR-001/SUC-001",
"data": [
{
"receipt": []
}
],
"error": {
"code": "ERR-142",
"message": "Resource not found",
"details": [
{
"code": "ER4001",
"message": "Invalid input",
"target": "username"
},
{
"code": "ER4002",
"message": "Missing field",
"target": "email"
}
],
"suggestions": [
"Check the resource ID",
"Ensure the resource exists"
],
"metaData": {}
},
"timestamp": "22024-10-14T14:28:11.284+01:00"
}