Terminate a payee engagement

post

https://api.wingspan.app/v3/payments/payees/{payeeId}/engagements/{payeeEngagementId}/terminate

Archive the payer's own side of an engagement. The payee's side is unchanged. On an engagement the payer created, this permanently transitions an Activated or Suspended engagement to Terminated (terminal state), and a Created engagement that never entered service must be removed with DELETE. On an engagement the payee created, it archives only the payer's side, as of an effectiveDate no later than today (UTC), and returns 409 payments.EngagementSideAlreadyArchived when that side is already archived. Returns 409 when the current state or dependent resources prevent termination, or a lifecycle transition is already in progress. Inspect detailCode for payeeEngagement.InvalidLifecycleTransition, payeeEngagement.LifecycleDependencyConflict, or payeeEngagement.LifecycleChangedConcurrently.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payeeId

string

required

^[A-Za-z0-9_.]{22,80}$

payeeEngagementId

string

required

Payee engagement ID (concrete assignment)

Body Params

Archive the caller's own side of an engagement. The side that created the engagement may name a future effectiveDate; its side is blocked at once either way. The other side's effectiveDate may not be later than today (UTC), and defaults to today.

effectiveDate

date

reason

string

Recorded when the side that created the engagement terminates it.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Payee engagement terminated

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error