Monime Documentation

Authorizations

Authorization

string

header

required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Space-Id

string

required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for. The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum string length: 64

Monime-Version

enum<string> | null

Specifies which version of the Monime API will handle this request. Specifies which version of the Monime API will handle this request.

Available options:

caph.2025-08-23,

caph.2025-06-20

Query Parameters

ussd_code

string | null

Filter by the USSD code assigned to the payment code (if applicable). Filter by the USSD code assigned to the payment code (if applicable).

mode

enum<string> | null

Filter by usage mode: 'one_time' for single-use codes, or 'recurrent' for reusable ones. Filter by usage mode: 'one_time' for single-use codes, or 'recurrent' for reusable ones.

Available options:

one_time,

recurrent

status

enum<string> | null

Filter by payment code status: 'pending' (not yet used), 'processing' (in use), 'expired' (duration elapsed), 'cancelled' (manually cancelled), or 'completed' (fulfilled as intended). Filter by payment code status: 'pending' (not yet used), 'processing' (in use), 'expired' (duration elapsed), 'cancelled' (manually cancelled), or 'completed' (fulfilled as intended).

Available options:

pending,

cancelled,

processing,

expired,

completed

limit

integer

default:10

Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified. Maximum number of items to return in a single page. Must be between 1 and 50. Defaults to 10 if not specified.

Required range: 1 <= x <= 50

after

string | null

Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward. Pagination cursor for fetching the next page of results. Set this to the 'next' cursor value from a previous response to continue paginating forward.

Maximum string length: 2000

Response

200 - application/json

success

boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

messages

any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result

Payment Code · object[] | null

The list of items in the response

Show child attributes

result.id

string

Unique identifier of the payment code object.

result.mode

enum<string>

Usage mode of the payment code:

'one_time': Can be used only once
'recurrent': Can be used multiple times until a target is met or it expires.

Available options:

one_time,

recurrent

result.status

enum<string>

Lifecycle status of the payment code: 'pending' (created but not in use), 'processing' (currently in use), 'expired' (duration elapsed), 'completed' (usage or target fulfilled), or 'cancelled' (manually invalidated).

Available options:

pending,

cancelled,

processing,

expired,

completed

result.name

string | null

Optional human-readable name for the payment code, useful for labeling or tracking.

Example:

"Home EDSA Meter Top-up"

result.amount

object

Amount charged per use of the payment code. For 'recurrent' mode, this applies to each payment instance.

Show child attributes

result.amount.currency

string

The 3-letter ISO currency code. Currently supported: 'SLE'

result.amount.value

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.

result.enable

boolean

Indicates whether the payment code is currently enabled for use.

result.expireTime

string<date-time>

The time at which the payment code expires, provided the code is still pending.

result.customer

object

Optional customer information linked to this payment code. Often used for USSD or receipt context.

Show child attributes

result.customer.name

string | null

Optional name of the customer associated with the payment code. Displayed in the USSD prompt for contextual reference.

Maximum string length: 100

Example:

"Musa Kamara"

result.ussdCode

string

The USSD dial string customer(s) can use to initiate a payment for this code.

result.reference

string | null

Reference string associated with the payment code. Useful for transaction tagging or reconciliation.

result.authorizedProviders

enum<string>[] | null

List of mobile money providers permitted to process payments using this code.

The ID of the MOMO as identified by Monime. E.g. m17 to denote Orange Money SL

Available options:

m17,

m18

Example:

["m17", "m18"]

result.authorizedPhoneNumber

string

MSISDN of the mobile money account exclusively allowed to use this code. Other users will be rejected.

result.recurrentPaymentTarget

object

Target payment count or amount that determines when a recurrent payment code is considered complete.

Show child attributes

result.recurrentPaymentTarget.expectedPaymentCount

integer | null

Minimum expected number of payments after which the recurrent payment code may be considered complete. Optional.

Required range: x >= 1

Example:

10

result.recurrentPaymentTarget.expectedPaymentTotal

object

Minimum total amount to be collected before the recurrent payment code is considered complete. Optional.

Show child attributes

result.recurrentPaymentTarget.expectedPaymentTotal.currency

string

The 3-letter ISO currency code. Currently supported: 'SLE'

result.recurrentPaymentTarget.expectedPaymentTotal.value

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.

result.financialAccountId

string | null

ID of the financial account where collected funds will be settled. Defaults to the main account if not provided.

result.processedPaymentData

object

The data of the payment that was processed for this payment code. This field is available only during the 'payment_code.processed' webhook event.

Show child attributes

result.processedPaymentData.amount

object

Show child attributes

result.processedPaymentData.amount.currency

string

The 3-letter ISO currency code. Currently supported: 'SLE'

result.processedPaymentData.amount.value

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.

result.processedPaymentData.orderId

string

result.processedPaymentData.paymentId

string

result.processedPaymentData.orderNumber

string

result.processedPaymentData.channelData

object

Show child attributes

result.processedPaymentData.channelData.providerId

string

result.processedPaymentData.channelData.accountId

string

result.processedPaymentData.channelData.reference

string

result.processedPaymentData.financialTransactionReference

string

result.processedPaymentData.metadata

object

Metadata is a flexible map of string key-value pairs for tagging or attaching additional information. A maximum of 64 pairs is allowed per object.

Show child attributes

result.processedPaymentData.metadata.{key}

string

Metadata values are free-form strings up to 100 characters.

Maximum string length: 100

result.createTime

string<date-time>

Timestamp indicating when the payment code was created.

result.updateTime

string<date-time> | null

Timestamp indicating when the payment code was last updated.

result.ownershipGraph

OwnershipGraph · object

Full ownership graph tracing the origin of this payment code objects across multiple objects.

Show child attributes

result.ownershipGraph.owner

OwnershipObject · object

Immediate object that owns this entity. This is the direct originator or source object.

Show child attributes

result.ownershipGraph.owner.id

string

Unique ID of the object instance that owns this entity.

result.ownershipGraph.owner.type

string

Type of the object that owns this entity. Examples include: 'internal_transfer', 'checkout_session', 'payment_code'.

result.ownershipGraph.owner.metadata

object

Arbitrary metadata describing the owning object.

Show child attributes

result.ownershipGraph.owner.metadata.{key}

string

Metadata values are free-form strings up to 100 characters.

Maximum string length: 100

result.ownershipGraph.owner.owner

OwnershipObject · object

Show child attributes

result.ownershipGraph.owner.owner.id

string

Unique ID of the object instance that owns this entity.

result.ownershipGraph.owner.owner.type

string

Type of the object that owns this entity. Examples include: 'internal_transfer', 'checkout_session', 'payment_code'.

result.ownershipGraph.owner.owner.metadata

object

Arbitrary metadata describing the owning object.

Show child attributes

result.ownershipGraph.owner.owner.metadata.{key}

string

Metadata values are free-form strings up to 100 characters.

Maximum string length: 100

result.ownershipGraph.owner.owner.owner

any

result.metadata

object

Custom metadata attached to the payment code for storing business-specific context or tags.

Show child attributes

result.metadata.{key}

string

Metadata values are free-form strings up to 100 characters.

Maximum string length: 100

pagination

object

The pagination info associated with the response

Show child attributes

pagination.count

integer

Number of items returned in the current page.

pagination.next

string | null

Cursor pointing to the next page of results. Use this value as the 'after' query parameter in your next request to fetch the following page. If null, you have reached the end of the result set.

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

List Payment Codes

Authorizations

Headers

Query Parameters

Response