Skip to main content
DELETE
Archive a Payee

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payee_id
string<uuid>
required

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Response

Confirmation that the payee was archived.

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.