v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Payout

Update Payout

Updates an existing payout object by ID. Fields can only be modified if the payout has not yet been processed.

patch/v1/payouts/{id}

Path parameters

idstring required

The unique ID of the payout object to update.

The unique ID of the payout object to update.

Headers

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

metadataobject nullable

Updated metadata for attaching custom information to the payout.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true