Platform endpoints — scheduled payments

How to call the scheduled-payment routes. The formal schema is the OpenAPI specification (openapi/source/platform/parties/parties.yml); this page is the call contract. The full payment + scheduled-payment lifecycle is in payment lifecycle.

All routes require a bearer token (B2B JWT) with CLIENT role and an ACTIVE party. Global /v1 prefix applies. Note: the controller prefix is /parties, not /payments.

Route summary

Method	Path	Code	Purpose
GET	/v1/parties/scheduled	200	List scheduled payments for the party
DELETE	/v1/parties/scheduled/:scheduledPaymentId	204	Cancel a scheduled payment

Scheduled payments are created via POST /v1/payments with a future requestedExecutionDate. There is no separate creation endpoint in this module — see Payments.

Route details

GET /v1/parties/scheduled — list scheduled payments

Returns all scheduled payments for the caller's party.

Important: DELETE /v1/parties/scheduled/:id requires that the platform has seen the scheduledPaymentId before — either via this list endpoint or a prior cancel attempt. If the resource has never been listed, the delete will fail with PAR004007. Call this endpoint first to ensure the platform knows about the scheduled payment.

---

DELETE /v1/parties/scheduled/:scheduledPaymentId — cancel scheduled payment (204)

Cancels the scheduled payment. The platform must have seen the scheduledPaymentId before — call the list endpoint first. An id the platform has not seen returns 404 PAR004007.

Path parameter: scheduledPaymentId (string, Ark scheduled-payment id).

Errors:

HTTP	Code	When
404	PAR004007	Scheduled payment not found (list first to register it)

Auth

All routes: bearer token (B2B JWT) with CLIENT role; party must be ACTIVE.