API Documentation
Core Resources
- Webhook
Checkout
- Session
Payments
- Payment Codes
- Payment Links
- Payment Pages
Transfers
- Payout
- Bulk Payout
Embedded Finance
- Financial Account
Extra Resources
- KYC Verification
- Financial Providers
- Available Countries
Get Payment Code
curl --request GET \
--url https://api.monime.io/payment-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Monime-Space-Id: <monime-space-id>'{
"success": true,
"messages": [
"<any>"
],
"result": {
"id": "pmc-TJh76H8hj778hftdtu66gjio",
"name": "Home EDSA Meter Top-up",
"mode": "oneTime",
"isActive": true,
"status": "pending",
"ussdCode": "\\*715\\*1\\*0123456789#",
"amount": {
"currency": "<string>",
"value": 123
},
"customerTarget": {
"name": "Musa Kamara",
"reference": "0123456789",
"payingPhoneNumber": "078000000"
},
"financialTarget": {
"expectedPaymentCount": 10,
"expectedPaymentSum": {
"currency": "<string>",
"value": 123
}
},
"allowedProviders": [
"m17",
"m18"
],
"progress": {
"isCompleted": true,
"totalPaymentCount": 123,
"totalPaymentSum": {
"currency": "<string>",
"value": 123
}
},
"financialAccountId": "<string>",
"expireTime": "2023-11-07T05:31:56Z",
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}Authorizations
Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>
Headers
The value is the tenancy parameter that Monime used to determine which space the request is intended for.
100Path Parameters
A unique identifier for the payment code object.
Response
Represents the status of the query operation, confirming if it was successful. This field is always true
Contains a list of messages providing relevant information or feedback related to the query or operation
A unique identifier for the payment code object.
"pmc-TJh76H8hj778hftdtu66gjio"
The name or intent indicating the purpose or use of the payment code.
100"Home EDSA Meter Top-up"
Specifies whether the payment code can be used only once or multiple times.
oneTime, recurrent Indicates whether the payment code is currently active and available for use.
The current status of the payment code, indicating its state in the payment process
pending, processing, expired, cancelled, completed The USSD code that users can dial on their mobile money device to make a payment using this payment code.
"\\*715\\*1\\*0123456789#"
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.
Information about the specific customer that this payment code is targeting/
Name of the customer to pay for this code.
100"Musa Kamara"
Reference that may identify this customer in some external system.
100"0123456789"
The phone number that should dial to pay for this code.
30"078000000"
The financial target for this payment code.
The number of payments expected after which the code gets completed.
x >= 110
The sum of payment amounts expected after which the code gets completed.
The list of MoMo provider IDs for which the payment code is allowed to be used.
["m17", "m18"]
The progress of the payment code.
Indicate whether the payment code is completed or not.
Represents the total number of payments made using this code.
Represents the total sum of payment amounts made using this code.
The ID of the financial account where the amount is settled to. This default to the owner's Main financial account.'
The expiration time of the payment code.
The creation time of the payment code.
The metadata for the payment code.
Was this page helpful?
curl --request GET \
--url https://api.monime.io/payment-codes/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Monime-Space-Id: <monime-space-id>'{
"success": true,
"messages": [
"<any>"
],
"result": {
"id": "pmc-TJh76H8hj778hftdtu66gjio",
"name": "Home EDSA Meter Top-up",
"mode": "oneTime",
"isActive": true,
"status": "pending",
"ussdCode": "\\*715\\*1\\*0123456789#",
"amount": {
"currency": "<string>",
"value": 123
},
"customerTarget": {
"name": "Musa Kamara",
"reference": "0123456789",
"payingPhoneNumber": "078000000"
},
"financialTarget": {
"expectedPaymentCount": 10,
"expectedPaymentSum": {
"currency": "<string>",
"value": 123
}
},
"allowedProviders": [
"m17",
"m18"
],
"progress": {
"isCompleted": true,
"totalPaymentCount": 123,
"totalPaymentSum": {
"currency": "<string>",
"value": 123
}
},
"financialAccountId": "<string>",
"expireTime": "2023-11-07T05:31:56Z",
"createTime": "2023-11-07T05:31:56Z",
"metadata": {}
}
}