Monime Documentation

{
    "id": "pmc-TJh76H8hj778hftdtu66gjio",
    "name": "Home EDSA Meter Top-up",
    "mode": "oneTime",
    "isActive": true,
    "status": "pending",
    "ussdCode": "*715*1*0123456789#",
    "amount": {
        "currency": null,
        "value": null
    },
    "customerTarget": {
        "name": "Musa Kamara",
        "reference": "0123456789",
        "payingPhoneNumber": "078000000"
    },
    "financialTarget": {
        "expectedPaymentCount": null,
        "expectedPaymentSum": {
            "currency": null,
            "value": null
        }
    },
    "allowedProviders": [
        [
            "m17",
            "m18"
        ]
    ],
    "progress": {
        "isCompleted": null,
        "totalPaymentCount": null,
        "totalPaymentSum": {
            "currency": null,
            "value": null
        }
    },
    "financialAccountId": null,
    "expireTime": null,
    "createTime": null,
    "metadata": null
}

Properties

string

A unique identifier for the payment code object.Example: pmc-TJh76H8hj778hftdtu66gjio

string

The name or intent indicating the purpose or use of the payment code.MaxLength: 100Example: Home EDSA Meter Top-up

enum<string>

Specifies whether the payment code can be used only once or multiple times.Available options: oneTime recurrentDefault: oneTime

boolean

Indicates whether the payment code is currently active and available for use.Default: true

enum<string>

The current status of the payment code, indicating its state in the payment processAvailable options: pending processing expired cancelled completedDefault: pending

string

The USSD code that users can dial on their mobile money device to make a payment using this payment code.Example: *715*1*0123456789#

object

The monetary amount assigned to the payment code. If mode is recurrent, and financial target sum is also set, this represents the amount to be paid for every instance of payment for this code.

Show properties

string

The 3-letter ISO currency code.

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

Information about the specific customer that this payment code is targeting/

Show properties

string

Name of the customer to pay for this code.MaxLength: 100Example: Musa Kamara

string

Reference that may identify this customer in some external system.MaxLength: 100Example: 0123456789

string

The phone number that should dial to pay for this code.MaxLength: 30Example: 078000000

object

The financial target for this payment code.

Show properties

integer

The number of payments expected after which the code gets completed.

object

The sum of payment amounts expected after which the code gets completed.

Show properties

string

The 3-letter ISO currency code.

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.

array

The list of MoMo provider IDs for which the payment code is allowed to be used.Example: [m17 m18]

object

The progress of the payment code.

Show properties

boolean

Indicate whether the payment code is completed or not.

integer

Represents the total number of payments made using this code.

object

Represents the total sum of payment amounts made using this code.

Show properties

string

The 3-letter ISO currency code.

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.

string

The ID of the financial account where the amount is settled to. This default to the owner’s Main financial account.’

string

The expiration time of the payment code.

string

The creation time of the payment code.

object

The metadata for the payment code.

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Object Model