{
    "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
}
Represents a customer payment made through Monime’s platform. It captures all relevant information about the payment, including the amount, status, channel (e.g., Mobile Money, Card, Bank), associated order, fees applied, and downstream financial transaction reference. This object serves as the central record for tracking and reconciling user-initiated payments in embedded or API-driven workflows. 
{
    "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
​
id
string
Unique identifier for the payment object.
​
status
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
​
amount
object
Total payment amount requested from the payer.
​
channel
object
Payment channel details (e.g., Mobile Money, Bank, Card) used to complete this payment.
​
name
string
Optional label for identifying or grouping the payment. Useful in dashboards or reporting tools.
​
reference
string
External reference to associate this payment with a system outside Monime (e.g., an order ID or invoice number).
​
orderNumber
string
Monime Order Number — internal order identifier associated with this payment. Used to track payments initiated from an embedded commerce or checkout session.
​
financialAccountId
string
ID of the destination financial account where the funds will be credited after a successful payment.
​
financialTransactionReference
string
Reference to the resulting financial transaction(s), if the payment was successful.
​
fees
array
List of applied fees associated with this payment, such as platform or processing fees.
​
createTime
string
Timestamp indicating when the payment was created.
​
updateTime
string
Timestamp indicating when the payment was last updated.
​
ownershipGraph
object
Ownership chain showing how this payment was initiated — enabling full audit traceability.
​
metadata
object
Custom metadata attached to the payment