API Reference

Deactivate a payee

delete
https://api.wingspan.app/v3/payments/payees/

Deactivate a Payee, preventing future payments. Returns 204 on success. Returns 409 with detailCode payments.PayeeHasActiveEngagements while the payee still has open engagements. Delete any you created that are still in Created, terminate the others, then delete the payee.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
Headers
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).

Responses
204

Payee deactivated

Updated 5 months ago

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

Updated 5 months ago

Did this page help you?