ResponseWrapperListBillerDto

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[]

Array [

billerCodestring

Unique code identifying the biller

Example: CR12345

billerNamestring

Name of the biller

Example: Maroc Telecom

descriptionstring

Brief description of the biller's services

Example: the number one Provider of Internet and telecom services in Morocco

logoPathstring

Path to the logo image file for the biller

Example: /images/logos/biller_logo.png

siteUrlstring

Website URL of the biller

Example: https://www.iam.com

categorystring

Category of the biller

Example: telecom_and_internet

billerTypestring

Type of the biller

debts object[]

List of associated debts

Array [

namestring

Name of the debt

Example: Porduit entreprise

codestring

Unique debt code

Example: debt123

categorystring

Category of the debt

Example: telecom_and_internet

billerIdstring

ID of the biller

Example: CR123456

logoPathstring

Path to the biller's logo

Example: https://www.iam.com/logos/biller.png

billerLabelstring

Label or name of the biller

Example: National Telecom Company

billerTypestring

Type of biller

Example: Company

idinteger<int64>

Unique identifier for this debt

Example: 789

refTxFatouratistring

Reference transaction for 'Fatourati' system

Example: FTX123456

]

typeOfSearchstring

The type of search

]

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

ResponseWrapperListBillerDto
{
  "status": "ERROR/SUCCESS",
  "message": "Request failed/Request successful",
  "codeMessage": "ERR-001/SUC-001",
  "data": [
    {
      "billerCode": "CR12345",
      "billerName": "Maroc Telecom",
      "description": "the number one Provider of Internet and telecom services in Morocco",
      "logoPath": "/images/logos/biller_logo.png",
      "siteUrl": "https://www.iam.com",
      "category": "telecom_and_internet",
      "billerType": "string",
      "debts": [
        {
          "name": "Porduit entreprise",
          "code": "debt123",
          "category": "telecom_and_internet",
          "billerId": "CR123456",
          "logoPath": "https://www.iam.com/logos/biller.png",
          "billerLabel": "National Telecom Company",
          "billerType": "Company",
          "id": 789,
          "refTxFatourati": "FTX123456"
        }
      ],
      "typeOfSearch": "string"
    }
  ],
  "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"
}

#ResponseWrapperListBillerDto

ResponseWrapperListBillerDto