Skip to main content

BillPaymentFavoriteDto

DTO representing a favorite bill payment for a user.

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
BillPaymentFavoriteDto
{
  "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
}