/bills

Get bill payments that occurred on your bank accounts

📘

category is either airtime, mobile-data, cable-tv, or electricity.

Response Schema:

JSON

{
  "status": boolean,
  "message": string,
  "data": {
    "billPayments": [
      {
        "id": string,
        "amount": string,
        "vendor": {
          "id": string,
          "name": string,
        },
        "category": "airtime" | "mobile-data" | "cable-tv" | "electricity",
        "product": {
          "id": string,
          "name": string,
          "vendor": {
            "id": string,
            "name": string,
          },
          "amount": {
            "type": "fixed" | "range",
            "fixed": string | null,
            "minimum": string | null,
            "maximum": string | null,
          },
          "customerIdLabel": string,
          "category": "airtime" | "mobile-data" | "cable-tv" | "electricity",
          "commissionPercentage": string,
        },
        "details": {
          "customerId": string,
          "customerName": string,
        },
        "debitAccountId": string,
        "instructions": string | null,
        "initiatedAt": date-time,
        "status": "pending" | "successful" | "failed",
        "completedAt": date-time | null,
        "failedAt": date-time | null,
        "reasonForFailure": string | null,
        "clientReference": string | null,
        "transactionReference": string,
        "commission": string | null,
      }
    ],
    "meta": {
      "total": number,
      "pageCount": number,
      "perPage": number,
      "currentPage": number
    }
  }
}