MOmonime
Payment Code

List Payment Codes

Retrieves a list of payment codes with support for filtering by mode, USSD code, and status.

get/v1/payment-codes

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/payment-codes
  • Auth
    HTTP bearer

Query parameters

ussd_codestring nullable

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

mode'one_time' | 'recurrent' nullable

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

status'pending' | 'cancelled' | 'processing' | 'expired' | 'completed' nullable

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

limitinteger

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

afterstring nullable

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

Headers

Monime-Space-Idstring required

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

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

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

Response

OK

successboolean

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

Example response

{
  "result": [
    {
      "name": "Home EDSA Meter Top-up",
      "customer": {
        "name": "Musa Kamara"
      },
      "authorizedProviders": [
        "m17",
        "m18"
      ],
      "recurrentPaymentTarget": {
        "expectedPaymentCount": 10
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.