---
title: "List Payments"
method: GET
path: "/v1/payments"
tags: ["Payment"]
---

# List Payments

`GET /v1/payments`

Lists payments with optional filters like status or creation date.

## Query parameters

- `orderNumber` string — The order number of the order associated to a payment.
- `financialAccountId` string — ID of the financial account that received the funds.
- `financialTransactionReference` string — The reference for the group of related financial transactions that were spawned for a payment
- `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` Payment[], nullable — The list of items in the response
    - `id` string — Unique identifier for the payment object.
    - `status` 'pending' | 'processing' | 'completed' — Current status of the payment. Can be one of: - pending: Created but not yet processed. - processing: Payment is currently being processed. - completed: Payment was successfully completed.
    - `amount` object — Total payment amount requested from the payer.
      - `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.
    - `channel` union — Payment channel details (e.g., Mobile Money, Bank, Card) used to complete this payment.
      - object
        - `type` 'bank' — **Type** of payment channel used to process the payment. Supported values: - bank: Bank account payments - card: Debit or credit card payments - momo: Mobile money payments - wallet: Digital wallet payments.
        - `provider` string — **Provider code** for the bank or financial institution facilitating the payment.
        - `reference` string — **Bank transaction reference** assigned by the provider when the payment was made. Often used for reconciliation and tracing within the bank’s system.
        - `accountNumber` string — **Bank account number** used to initiate the payment. This is usually masked to protect user privacy.
        - `fingerprint` string — **Hashed account number**. A hashed identifier derived from the account number. Enables repeat usage recognition, fraud analysis, and loyalty program tracking — without exposing raw account number.
        - `metadata` object, nullable — **Optional metadata** for attaching contextual information relevant for audits, reconciliation, or internal processing.
      - object
        - `type` 'card' — **Type** of payment channel used to process the payment. Supported values: - bank: Bank account payments - card: Debit or credit card payments - momo: Mobile money payments - wallet: Digital wallet payments.
        - `scheme` 'mastercard' | 'visa' — **Card scheme** such as 'visa' or 'mastercard'.
        - `last4` string — **Last four digits** of the card number used. Helpful for user recognition and support.
        - `fingerprint` string — **Card fingerprint**. A hashed identifier derived from the card number. Enables repeat usage recognition, fraud analysis, and loyalty program tracking — without exposing the card number.
        - `metadata` object, nullable — **Optional metadata** for attaching contextual information useful for audit trails or internal reconciliation.
      - object
        - `type` 'wallet' — **Type** of payment channel used to process the payment. Supported values: - bank: Bank account payments - card: Debit or credit card payments - momo: Mobile money payments - wallet: Digital wallet payments.
        - `provider` string — **Wallet provider** code or identifier.
        - `reference` string — **Wallet transaction reference** assigned when the payment was executed. Often used for reconciliation and user support.
        - `walletId` string — **Wallet identifier** representing the source wallet involved in the transaction. Usually masked or obfuscated.
        - `fingerprint` string — **Hashed wallet identifier**. Enables secure correlation, repeat-usage detection, and loyalty programs — while preserving privacy.
        - `metadata` object, nullable — **Optional metadata** for attaching contextual or audit-related details about the wallet transaction.
      - object
        - `type` 'momo' — **Type** of payment channel used to process the payment. Supported values: - bank: Bank account payments - card: Debit or credit card payments - momo: Mobile money payments - wallet: Digital wallet payments.
        - `provider` string — **Provider code** for the Mobile Money operator (e.g., 'm17' for Orange Money) that is facilitating the payment.
        - `reference` string — **Network transaction reference** assigned by the Mobile Money operator when the payment was made. This is often visible to the payer and useful for tracing the transaction in the provider’s system.
        - `phoneNumber` string — **Phone number (MSISDN)** of the Mobile Money wallet that initiated the payment. This is usually masked for privacy and security.
        - `fingerprint` string — **Hashed phone number**. A hashed identifier derived from the phone number. Enables repeat usage recognition, fraud analysis, and loyalty program tracking — without exposing the raw phone number.
        - `metadata` object, nullable — **Optional metadata** for attaching extra contextual information useful for audit logs, reconciliation, or internal tracking.
    - `name` string, nullable — Optional label for identifying or grouping the payment. Useful in dashboards or reporting tools.
    - `reference` string, nullable — External reference to associate this payment with a system outside Monime (e.g., an order ID or invoice number).
    - `orderNumber` string, nullable — Monime Order Number — internal order identifier associated with this payment. Used to track payments initiated from an embedded commerce or checkout session.
    - `financialAccountId` string, nullable — ID of the destination financial account where the funds will be credited after a successful payment.
    - `financialTransactionReference` string, nullable — Reference to the resulting financial transaction(s), if the payment was successful.
    - `fees` object[], nullable — List of applied fees associated with this payment, such as platform or processing fees.
      - `code` string — The type of fee applied.
      - `amount` object — The amount of the fee that was applied for the payment.
        - `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.
    - `createTime` string, date-time — Timestamp indicating when the payment was created.
    - `updateTime` string, date-time, nullable — Timestamp indicating when the payment was last updated.
    - `ownershipGraph` object, nullable — Ownership chain showing how this payment was initiated — enabling full audit traceability.
      - `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 — Custom metadata attached to the payment
  - `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)