Skip to main content

ResponseWrapperBalanceHistoryDto

Wrapper for the response containing paginated account balance history.

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS
messagestring

Message describing the response

Example: Request failed/Request successful
codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001
data object

DTO representing the balance history, including balance amounts, credit and debit details, and related dates.

balancesnumber[]

List of balance amounts for each corresponding date in the history

Example: [1000,1200.5,1300.75]
datesstring[]

List of dates associated with each balance record

Example: ["2024-01-01","2024-02-01","2024-03-01"]
creditsnumber[]

List of credit amounts recorded for each date

Example: [200,150.5,300.75]
debitsnumber[]

List of debit amounts recorded for each date

Example: [50,40.25,80]
currencystring

Currency of the balance amounts

Example: TND
error object

Detailed information about the error response

codestring

Error code

Example: ERR-142
messagestring

Error message

Example: Resource not found / Internal server error
details object[]

List of error details

  • Array [
  • codestring

    Error code

    Example: ER4001
    messagestring

    Detailed error message

    Example: Invalid input
    targetstring

    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"}
    timestampdate-time

    Timestamp of when the response was generated

    ResponseWrapperBalanceHistoryDto
    {
    "status": "ERROR/SUCCESS",
    "message": "Request failed/Request successful",
    "codeMessage": "ERR-001/SUC-001",
    "data": {
    "balances": [
    1000,
    1200.5,
    1300.75
    ],
    "dates": [
    "2024-01-01",
    "2024-02-01",
    "2024-03-01"
    ],
    "credits": [
    200,
    150.5,
    300.75
    ],
    "debits": [
    50,
    40.25,
    80
    ],
    "currency": "TND"
    },
    "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"
    }