---
title: "List Payouts"
method: GET
path: "/v1/payouts"
tags: ["Payout"]
---

# List Payouts

`GET /v1/payouts`

Retrieves list of payouts.

## 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
- `sourceFinancialAccountId` string, nullable — Filter payouts by the originating financial account. Useful for scoping to a specific wallet or reserve account.
- `sourceTransactionReference` string, nullable — Reference for the batch or group of financial transactions triggered as part of a payout. Enables traceability across related entries.
- `destinationTransactionReference` string, 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.
- `limit` integer — Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.
- `after` string, 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-Id` string, 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 `200`

OK

- object
  - `success` boolean — Represents the status of the query operation, confirming if it was successful. This field is always true
  - `messages` unknown[] — Contains a list of messages providing relevant information or feedback related to the query or operation
    - unknown
  - `result` Payout[], nullable — The list of items in the response
    - `id` string — Unique identifier for the payout object.
    - `status` 'pending' | 'processing' | 'completed' | 'failed' — Current status of the payout: - 'pending': Created but not yet scheduled.- 'processing': Currently being processed. - 'completed': Successfully completed. - 'failed': Processing failed or rejected.
    - `amount` object — Amount to be paid to the destination provider account.
      - `currency` string — The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO currency code. Currently supported: 'SLE'
      - `value` integer — The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.
    - `source` object, nullable — SourceAccount of funds, including debit account and transaction details. Can be null if the default account is used.
      - `financialAccountId` string, required — ID of the financial account where the funds is disbursed from.
      - `transactionReference` string, nullable — Internal Monime reference for the debit transaction from the source account. This is null until the payout is processed.
    - `destination` union — Destination account details that will receive the payout.
      - object
        - `type` 'bank', required — Specifies the type of destination account. Must be either 'bank', 'momo', or 'wallet'.
        - `providerId` 'slb001' | 'slb004' | 'slb007', required — Identifier of the bank or financial service provider.
        - `accountNumber` string, required — The bank account number to which the payout will be sent.
        - `transactionReference` string, nullable — Reference or identifier of the underlying transaction that credited the recipient’s bank account. Will be 'null' if the payout is not 'completed'.
      - object
        - `type` 'momo', required — Specifies the type of destination account. Must be either 'bank', 'momo', or 'wallet'.
        - `providerId` 'm17' | 'm18', required — Identifier of the mobile money provider.
        - `phoneNumber` string, required — The mobile number (MSISDN) of the recipient's mobile money account.
        - `transactionReference` string, nullable — Reference or ID of the transaction that credited the recipient’s mobile money wallet. Set to 'null' if the payout is not 'completed'.
      - object
        - `type` 'wallet', required — Specifies the type of destination account. Must be either 'bank', 'momo', or 'wallet'.
        - `providerId` 'dw001', required — Identifier of the digital wallet provider.
        - `walletId` string — The ID of the recipient's wallet in the digital wallet ecosystem.
        - `transactionReference` string, nullable — Reference or ID of the transaction that credited the recipient’s wallet. Set to null if the payout has not reached completed status.
    - `fees` object[], nullable — List of fees applied during payout processing. Empty if not yet processed.
      - `code` string — The type of fee applied.
      - `amount` object — The amount of the fee that was applied on top of the payout amount.
        - `currency` string — The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO currency code. Currently supported: 'SLE'
        - `value` integer — The value representation in the currency's minor unit. E.g. For 1 Leone (SLE 1), the value should be 100, denoting cents, the minor unit.
      - `metadata` object, nullable — Further metadata describing the fee.
    - `failureDetail` object, nullable — Detailed information about the failure, if the payout status is 'failed'.
      - `code` 'unknown' | 'fund_insufficient' | 'authorization_failed' | 'provider_unknown' | 'provider_account_blocked' | 'provider_account_missing' | 'provider_account_quota_exhausted' — **Error code** indicating why the payout failed. Possible values include: - unknown: General or unclassified failure. - fund_insufficient: Source account lacks sufficient funds. - authorization_failed: Authorization failed or was denied. - provider_unknown: Unexpected error from the external provider. - provider_account_blocked: The destination provider account is blocked. - provider_account_missing: The destination provider account does not exist. - provider_account_quota_exhausted: Daily or per-transaction quota has been exceeded.
      - `message` string — **Human-readable message** providing more context about the failure. Useful for logs, dashboards, or client-facing error messages.
    - `createTime` string, date-time — Timestamp indicating when the payout object was created.
    - `updateTime` string, date-time — Timestamp indicating when the payout object was last updated.
    - `ownershipGraph` object, nullable — Full ownership graph tracing the origin of this payout objects across multiple objects.
      - `owner` object — **Immediate object** that owns this entity. This is the direct originator or source object.
        - `id` string — **Unique ID** of the object instance that owns this entity.
        - `type` string — **Type of the object** that owns this entity. Examples include: 'internal_transfer', 'checkout_session', 'payment_code'.
        - `metadata` object, nullable — **Arbitrary metadata** describing the owning object.
        - `owner` CoreresourcesParentOwningObject
          - `id` string — **Unique ID** of the object instance that owns this entity.
          - `type` string — **Type of the object** that owns this entity. Examples include: 'internal_transfer', 'checkout_session', 'payment_code'.
          - `metadata` object, nullable — **Arbitrary metadata** describing the owning object.
          - `owner` CoreresourcesParentOwningObject — recursive
    - `metadata` object, nullable — Optional metadata attached to the payout for additional context.
  - `pagination` object — The pagination info associated with the response
    - `count` integer — Number of items returned in the current page.
    - `next` string, nullable — Cursor pointing to the next page of results. Use this value as the 'after' query parameter in your next request to fetch the following page. If null, you have reached the end of the result set.

---

[API](https://skmtc.dev/monime/apis/monime-api.md) · [All operations](https://skmtc.dev/monime/apis/monime-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/monime/monime-api/revisions/bd7f875ea428/schema)