Payout

Creates a new payout with a specified amount, destination, and optional source account.

post/v1/payouts

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/payouts
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

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

metadataobject nullable

Optional metadata to associate additional business context with the payout.

Response

OK

successboolean

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

Changes

    • warning

      added the new slb009 enum value to the /// response property for the response status

    • warning

      added the new slb013 enum value to the /// response property for the response status

    • info

      added the new slb009 enum value to the request property //

    • info

      added the new slb013 enum value to the request property //