> ## Documentation Index
> Fetch the complete documentation index at: https://docs.monime.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Payment

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.

<ResponseExample>
  ```json JSON Model theme={null}
  {
      "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
  }
  ```
</ResponseExample>

<ResponseField name="📋" type="Properties">
  <ResponseField name="id" type="string">
    Unique identifier for the payment object.
  </ResponseField>

  <ResponseField name="status" type="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: <code>pending</code> <code>processing</code> <code>completed</code>
  </ResponseField>

  <ResponseField name="amount" type="object">
    Total payment amount requested from the payer.

    <Expandable title="properties">
      <ResponseField name="currency" type="string">
        The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO currency code. Currently supported: 'SLE', 'USD'
      </ResponseField>

      <ResponseField name="value" type="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.
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="channel" type="object">
    Payment channel details (e.g., Mobile Money, Bank, Card) used to complete this payment.

    <Expandable title="properties">
      <ResponseField name="type" type="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: <code>bank</code> <code>card</code> <code>momo</code> <code>wallet</code>
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="name" type="string">
    Optional label for identifying or grouping the payment. Useful in dashboards or reporting tools.
  </ResponseField>

  <ResponseField name="reference" type="string">
    External reference to associate this payment with a system outside Monime (e.g., an order ID or invoice number).
  </ResponseField>

  <ResponseField name="orderNumber" type="string">
    Monime Order Number — internal order identifier associated with this payment. Used to track payments initiated from an embedded commerce or checkout session.
  </ResponseField>

  <ResponseField name="financialAccountId" type="string">
    ID of the destination financial account where the funds will be credited after a successful payment.
  </ResponseField>

  <ResponseField name="financialTransactionReference" type="string">
    Reference to the resulting financial transaction(s), if the payment was successful.
  </ResponseField>

  <ResponseField name="fees" type="array">
    List of applied fees associated with this payment, such as platform or processing fees.
  </ResponseField>

  <ResponseField name="createTime" type="string">
    Timestamp indicating when the payment was created.
  </ResponseField>

  <ResponseField name="updateTime" type="string">
    Timestamp indicating when the payment was last updated.
  </ResponseField>

  <ResponseField name="ownershipGraph" type="object">
    Ownership chain showing how this payment was initiated — enabling full audit traceability.

    <Expandable title="properties">
      <ResponseField name="owner" type="object">
        **Immediate object** that owns this entity. This is the direct originator or source object.

        <Expandable title="properties">
          <ResponseField name="id" type="string">
            **Unique ID** of the object instance that owns this entity.
          </ResponseField>

          <ResponseField name="type" type="string">
            **Type of the object** that owns this entity. Examples include: 'internal\_transfer', 'checkout\_session', 'payment\_code'.
          </ResponseField>

          <ResponseField name="metadata" type="object">
            **Arbitrary metadata** describing the owning object.
          </ResponseField>

          <ResponseField name="" type="" />
        </Expandable>
      </ResponseField>
    </Expandable>
  </ResponseField>

  <ResponseField name="metadata" type="object">
    Custom metadata attached to the payment
  </ResponseField>
</ResponseField>