WebsiteWe're hiringCourses & Certifications→ Get started for free
API Reference

Unschedule a scheduled payment

post
https://sandbox.uk.rootplatform.com/v1/insurance/scheduled-payments//unschedule

Cancels a pending scheduled payment so it will not be collected. The caller must pass the schedule's current version for optimistic-locking; a stale version returns 409 Conflict. Only pending schedules can be unscheduled. Returns 200 OK with the scheduled payment id on success.

Path Params
string
required

The unique identifier of the scheduled payment.

Query Params
string

To perform an idempotent request, provide the idempotency_key query parameter with the request. An idempotency key is a unique value generated by the client which the platform uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using a V4 UUID, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.

Body Params
string
enum
required

Why the schedule was cancelled.

Allowed:
integer
required

The schedule's current version, for optimistic-locking.

Responses

409

The schedule is not pending, or the supplied version is stale.

Updated about 1 month ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?