Monime Documentation

A Payment represents a customer payment made through Monime’s platform.
It captures high-level information about the user-initiated payment, including the amount, status, channel (e.g., Mobile Money, Card, Bank), associated order, fees applied, and links to downstream financial transactions. The Payment is a business object — the single record developers and merchants interact with when tracking or reconciling user payments.
It should not be confused with Financial Transactions, which are lower-level, fine-grained ledger entries.
In fact, one Payment usually generates multiple Financial Transactions — for example:

A credit of the received funds into the merchant’s account.
One or more debits representing platform charges or processing fees.

{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "channel": {
        "type": "bank"
    },
    "name": null,
    "reference": null,
    "orderNumber": null,
    "financialAccountId": null,
    "financialTransactionReference": null,
    "fees": [],
    "createTime": null,
    "updateTime": null,
    "ownershipGraph": {
        "owner": {
            "id": null,
            "type": null,
            "metadata": null,
            "": null
        }
    },
    "metadata": null
}

Properties

string

Unique identifier for the payment object.

enum<string>

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.

Available options: pending processing completed

object

Total payment amount requested from the payer.

Show properties

string

The 3-letter ISO currency code. Currently supported: ‘SLE’, ‘USD’

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.

object

Payment channel details (e.g., Mobile Money, Bank, Card) used to complete this payment.

Show properties

enum<string>

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.

Available options: bank card momo wallet

string

Optional label for identifying or grouping the payment. Useful in dashboards or reporting tools.

string

External reference to associate this payment with a system outside Monime (e.g., an order ID or invoice number).

string

Monime Order Number — internal order identifier associated with this payment. Used to track payments initiated from an embedded commerce or checkout session.

string

ID of the destination financial account where the funds will be credited after a successful payment.

string

Reference to the resulting financial transaction(s), if the payment was successful.

array

List of applied fees associated with this payment, such as platform or processing fees.

string

Timestamp indicating when the payment was created.

string

Timestamp indicating when the payment was last updated.

object

Ownership chain showing how this payment was initiated — enabling full audit traceability.

Show properties

object

Immediate object that owns this entity. This is the direct originator or source object.

Show properties

string

Unique ID of the object instance that owns this entity.

string

Type of the object that owns this entity. Examples include: ‘internal_transfer’, ‘checkout_session’, ‘payment_code’.

object

Arbitrary metadata describing the owning object.

object

Custom metadata attached to the payment

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Payment