Payment

Patch Payment

Updates mutable fields of a payment object like name, description, or metadata.

patch/v1/payments/{id}

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/payments/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the payment 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.

Monime-Space-Idstring required

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

Request body

namestring nullable

New label for the payment. Useful for reclassifying or tagging.

metadataobject nullable

Structured metadata to enrich or tag the payment.

Response

OK

successboolean

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

Changes

No recorded changes to this operation across all 2 revisions of this API.