Cancel a payout intent's active schedule

DELETE

/payout-intent-schedules/{id}

Cancels the active schedule on a scheduled or recurring payout intent, stopping any further automatic occurrences from being dispatched. The intent's status transitions to cancelled and next_run_at is cleared. This only applies to payout intents currently in the scheduled or recurring state — intents in any other state (including those whose schedule has already run to completion or been previously cancelled) cannot be cancelled through this endpoint. Cancellation is race-safe: the scheduling worker re-checks the intent's status immediately before firing or re-arming the next occurrence, so a cancellation that lands concurrently with a scheduled run will still prevent any further occurrences.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

The payout intent's schedule was cancelled successfully. The full, current representation of the intent is returned with status set to cancelled and next_run_at cleared.

Bodyapplication/json

🟠400

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/payout-intent-schedules/01J3KQZM0000000000000000AB' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Payout intent schedule cancelled successfully",
    "status": "success",
    "data": {
        "id": "01J3KQZM0000000000000000AB",
        "entity_id": "01J3KQ0000000000000000ENTT",
        "account_id": "01J3KQABC0000000000000000X",
        "currency": "NGN",
        "amount": 500000,
        "client_reference": "payout_ref_20250805_0091",
        "status": "cancelled",
        "type": "single",
        "schedule": {
            "type": "recurring",
            "start_at": 1754500000000,
            "max_occurrences": 12,
            "interval_ms": 2592000000
        },
        "action_template": {
            "type": "payout",
            "currency": "NGN",
            "amount": 500000,
            "counterparty": {
                "email": "vendor@example.com",
                "account_number": "0123456789",
                "bank_code": "058"
            }
        },
        "next_run_at": null,
        "occurrence_count": 3,
        "last_fired_at": 1759233600000,
        "created": 1754388720000,
        "updated": 1759320000000
    }
}

Modified at 2026-09-28 15:32:50

Edit a payout intent

Edit a payout intent's active schedule