Skip to main content
{
    "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
​
id
string
A unique identifier for the payment code object.Example: pmc-TJh76H8hj778hftdtu66gjio
​
name
string
The name or intent indicating the purpose or use of the payment code.MaxLength: 100Example: Home EDSA Meter Top-up
​
mode
enum<string>
Specifies whether the payment code can be used only once or multiple times.Available options: oneTime recurrentDefault: oneTime
​
isActive
boolean
Indicates whether the payment code is currently active and available for use.Default: true
​
status
enum<string>
The current status of the payment code, indicating its state in the payment processAvailable options: pending processing expired cancelled completedDefault: pending
​
ussdCode
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#
​
amount
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.
​
customerTarget
object
Information about the specific customer that this payment code is targeting/
​
financialTarget
object
The financial target for this payment code.
​
allowedProviders
array
The list of MoMo provider IDs for which the payment code is allowed to be used.Example: [m17 m18]
​
progress
object
The progress of the payment code.
​
financialAccountId
string
The ID of the financial account where the amount is settled to. This default to the owner’s Main financial account.’
​
expireTime
string
The expiration time of the payment code.
​
createTime
string
The creation time of the payment code.
​
metadata
object
The metadata for the payment code.