ResponseWrapperPaginationDtoBillPaymentFavoriteDto

Generic API response wrapper

statusstring

Response status

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

Represents paginated results.

content object[]

The list of items in the current page.

Array [

idinteger<int64>

Unique identifier of the favorite.

Example: 1001

categorystring

Category of the favorite item.

Example: Electricity

billerIdstring

Identifier of the biller associated with the favorite.

Example: BILLER123

billerLabelstring

Label of the biller associated with the favorite.

Example: Electricity Company

debtIdstring

Identifier of the debt associated with the favorite.

Example: DEBT456

debtLabelstring

Label of the debt associated with the favorite.

Example: Electricity Subscription

dynamicFormFieldsstring[]

Dynamic form fields associated with the favorite.

Example: ["accountNumber","customerCode"]

favoriteLabelstring

Label assigned to the favorite by the user.

Example: My Electric Bill

formInputstring

Input data for the form associated with the favorite.

Example: {"accountNumber":"00162000017130","customerCode":"ABC123"}

logoUrlstring

URL of the logo associated with the favorite.

Example: https://example.com/logos/electricity.png

numberOfBillsinteger<int64>

Number of unpaid bills associated with the favorite.

Example: 2

]

totalElementsinteger<int64>

The total number of elements across all pages.

Example: 100

totalPagesinteger<int32>

The total number of pages available.

Example: 10

numberinteger<int32>

The current page number (zero-based).

Example: 0

sizeinteger<int32>

The number of items per page.

Example: 10

error object

Details of any error that occurred

codestring

Error code

Example: ERR-142

messagestring

Human-readable error message

Example: Resource not found

details object[]

List of error details

Array [

codestring

Specific error code

Example: ER4001

messagestring

What went wrong

Example: Invalid input

targetstring

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:00

ResponseWrapperPaginationDtoBillPaymentFavoriteDto
{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": {
    "content": [
      {
        "id": 1001,
        "category": "Electricity",
        "billerId": "BILLER123",
        "billerLabel": "Electricity Company",
        "debtId": "DEBT456",
        "debtLabel": "Electricity Subscription",
        "dynamicFormFields": [
          "accountNumber",
          "customerCode"
        ],
        "favoriteLabel": "My Electric Bill",
        "formInput": {
          "accountNumber": "00162000017130",
          "customerCode": "ABC123"
        },
        "logoUrl": "https://example.com/logos/electricity.png",
        "numberOfBills": 2
      }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
  },
  "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"
}

#ResponseWrapperPaginationDtoBillPaymentFavoriteDto

ResponseWrapperPaginationDtoBillPaymentFavoriteDto