Options

GET

https://api.paybeta.ng/v2/scheduled-payments/options

Services, billers, frequencies and meter types accepted by Create, plus min_lead_minutes and the timezone used for dates.

Request

Authorization

Add parameter in header

P-API-KEY

Example:

P-API-KEY: ********************

Header Params

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.paybeta.ng/v2/scheduled-payments/options' \
--header 'Accept: application/json' \
--header 'Accept: application/json' \
--header 'P-API-KEY: <api-key>' \
--header 'Content-Type: application/json'

Response Example

{
  "success": true,
  "data": {
    "services": [
      {
        "key": "airtime",
        "label": "Airtime",
        "billers": [
          {
            "biller": "mtn_vtu",
            "name": "MTN Airtime",
            "has_bundles": false
          }
        ]
      },
      {
        "key": "data",
        "label": "Internet Data",
        "billers": [
          {
            "biller": "mtn_data",
            "name": "MTN Data",
            "has_bundles": true
          }
        ]
      },
      {
        "key": "cabletv",
        "label": "Cable TV",
        "billers": [
          {
            "biller": "dstv",
            "name": "DStv",
            "has_bundles": true
          }
        ]
      },
      {
        "key": "electricity",
        "label": "Electricity",
        "billers": [
          {
            "biller": "ikeja-electric",
            "name": "Ikeja Electric - IKEDC",
            "has_bundles": false
          }
        ]
      }
    ],
    "frequencies": [
      {
        "key": "once",
        "label": "One time"
      },
      {
        "key": "daily",
        "label": "Daily"
      },
      {
        "key": "weekly",
        "label": "Weekly"
      },
      {
        "key": "monthly",
        "label": "Monthly"
      }
    ],
    "meter_types": [
      {
        "key": "prepaid",
        "label": "Prepaid Meter"
      },
      {
        "key": "postpaid",
        "label": "Postpaid Meter"
      }
    ],
    "min_lead_minutes": 10,
    "timezone": "Africa/Lagos"
  }
}

Modified at 2026-10-05 20:31:57

Webhook (reference)

Bundles