MOmonime
Payout

List Payouts

Changed on

Retrieves list of payouts.

get/v1/payouts

Request

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

Query parameters

status'pending' | 'processing' | 'failed' | 'completed' nullable

Filter payouts by status:

  • 'pending': Awaiting processing
  • 'processing': Currently being processed
  • 'failed': Processing failed
  • 'completed': Successfully disbursed
sourceFinancialAccountIdstring nullable

Filter payouts by the originating financial account. Useful for scoping to a specific wallet or reserve account.

sourceTransactionReferencestring nullable

Reference for the batch or group of financial transactions triggered as part of a payout. Enables traceability across related entries.

destinationTransactionReferencestring nullable

Filter by the transaction reference assigned by the destination provider (e.g., a bank or wallet system). Useful for reconciliation with third-party systems.

limitinteger

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

afterstring nullable

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Headers

Monime-Space-Idstring required

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

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

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

Response

OK

successboolean

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

Changes

  • fd6fd8884fefRevision 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