MOmonime
Payment Code

Get Payment Code

Retrieve a payment code object by its ID.

get/v1/payment-codes/{id}

Request

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

Path parameters

idstring required

Unique identifier of the payment code to retrieve.

Headers

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

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

Monime-Space-Idstring required

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

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.