VTU API
Get API keys
Schedule Payments›Manage

Get schedule

GET https://api.paybeta.ng/v2/scheduled-payments/{schedulereference}

One schedule including its full run history (runs).

Send your secret key in the P-API-KEY header. Keep it on your server, never in an app or browser.

Path parameters

  • schedulereference string Required
    Example: SCH-9SC5QIH5GNLC

Responses

  • 200Success
  • 404Error
Request
curl --request GET \
  --url 'https://api.paybeta.ng/v2/scheduled-payments/{schedulereference}' \
  --header 'Accept: application/json' \
  --header 'P-API-KEY: YOUR_SECRET_KEY'
Response
{
    "status": "successful",
    "data": {
        "reference": null,
        "schedule_id": "SCH-9SC5QIH5GNLC",
        "service": "airtime",
        "service_label": "Airtime",
        "biller": "mtn_vtu",
        "biller_label": "MTN Airtime",
        "biller_code": null,
        "product_name": "MTN Airtime VTU",
        "customer_id": "08123456780",
        "customer_name": null,
        "amount": 100,
        "frequency": "once",
        "frequency_label": "One time",
        "starts_at": "2026-10-05T03:40:00+01:00",
        "ends_at": null,
        "next_run_at": null,
        "status": "completed",
        "failure_reason": null,
        "can_retry": false,
        "can_cancel": false,
        "can_pause": false,
        "can_pay_now": false,
        "can_resume": false,
        "resume_needs_start_at": false,
        "paused_at": null,
        "can_edit": false,
        "archived": false,
        "can_reactivate": false,
        "can_delete": false,
        "reactivation_needs_start_at": false,
        "cancelled_at": null,
        "total_runs": 1,
        "last_run_at": "2026-10-05T03:40:47+01:00",
        "last_run": {
            "cycle": 1,
            "attempt": 1,
            "trigger": "auto",
            "due_at": "2026-10-05T03:40:00+01:00",
            "status": "delivered",
            "response_description": "TRANSACTION SUCCESSFUL",
            "transaction_id": "API-1791168046493950345",
            "transaction_reference": "SCH-9SC5QIH5GNLC-B9AP46D6",
            "amount": 100,
            "charged_amount": 97,
            "token": null,
            "started_at": "2026-10-05T03:40:44+01:00",
            "finished_at": "2026-10-05T03:40:47+01:00"
        },
        "description": "Airtime for Dad",
        "summary": "Airtime scheduled for the beneficiary 08138539550",
        "created_at": "2026-10-05T03:25:41+01:00",
        "runs": [
            {
                "cycle": 1,
                "attempt": 1,
                "trigger": "auto",
                "due_at": "2026-10-05T03:40:00+01:00",
                "status": "delivered",
                "response_description": "TRANSACTION SUCCESSFUL",
                "transaction_id": "API-1791168046493950345",
                "transaction_reference": "SCH-9SC5QIH5GNLC-B9AP46D6",
                "amount": 100,
                "charged_amount": 97,
                "token": null,
                "started_at": "2026-10-05T03:40:44+01:00",
                "finished_at": "2026-10-05T03:40:47+01:00"
            }
        ]
    }
}