Edit a payout intent's active schedule

Updates the schedule configuration of a payout intent that is currently scheduled, recurring, or paused. Use this to change the disbursed amount, the debit account_id, the timing of the next occurrence (next_run_at), or the recurrence cadence (interval_ms/cron) of a recurring schedule. Fields omitted from the request body are left unchanged; only fields explicitly supplied are updated. interval_ms and cron are only applicable to recurring schedules and are mutually exclusive — supplying one clears the other. Changing next_run_at, interval_ms, or cron re-arms the underlying scheduling job against the new timing; if the intent is currently paused, the job is disarmed but not re-armed until the schedule is resumed. If the intent also has an action_template, any updated amount or account_id is mirrored onto the template's own amount/account_id fields (when those fields are present on the template) so future auto-dispatched occurrences reflect the change.

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

Body Params application/jsonRequired

Examples

application/json

The payout intent schedule was updated successfully. The full, current representation of the intent is returned with the applied changes.

Bodyapplication/json

curl --location --request PATCH '/payout-intent-schedules/01J3KQZM0000000000000000AB' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "amount": 750000, "next_run_at": 1762000000000, "cron": "0 9 1 * *" }'

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

Edit a payout intent's active schedule

Request

Responses