Cancel (archive)

POST

https://api.paybeta.ng/v2/scheduled-payments/{{scheduleReference}}/cancel

Stop an active, failed or paused schedule and move it to the archive (status: cancelled). It can be re-enabled later.

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 --globoff --request POST 'https://api.paybeta.ng/v2/scheduled-payments/{{scheduleReference}}/cancel' \
--header 'Accept: application/json' \
--header 'Accept: application/json' \
--header 'P-API-KEY: <api-key>' \
--header 'Content-Type: application/json'

Response Example

{
  "success": true,
  "message": "Schedule cancelled and moved to archive.",
  "data": {
    "reference": "SCH-7F3K9QX2AB12",
    "service": "data",
    "service_label": "Internet Data",
    "biller": "mtn_data",
    "biller_label": "MTN Data",
    "biller_code": "mtn-1gb-30days",
    "product_name": "MTN 1GB - 30 Days",
    "customer_id": "08031234567",
    "customer_name": null,
    "amount": 1000.0,
    "frequency": "monthly",
    "frequency_label": "Monthly",
    "starts_at": "2026-11-01T09:00:00+01:00",
    "ends_at": null,
    "next_run_at": null,
    "status": "cancelled",
    "failure_reason": null,
    "can_retry": false,
    "can_cancel": true,
    "can_pause": true,
    "can_pay_now": true,
    "can_resume": false,
    "resume_needs_start_at": false,
    "paused_at": null,
    "can_edit": true,
    "archived": true,
    "can_reactivate": true,
    "can_delete": true,
    "reactivation_needs_start_at": false,
    "cancelled_at": "2026-10-05T12:30:00+01:00",
    "total_runs": 0,
    "last_run_at": null,
    "last_run": null,
    "description": "Data for Mum",
    "summary": "Internet Data scheduled for the beneficiary 08031234567",
    "created_at": "2026-10-05T12:00:00+01:00"
  }
}

Modified at 2026-10-05 19:53:45

Resume

Re-enable