Sign in

v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Payment Code

Create Payment Code

Creates a new payment code with the specified parameters for value collection and provider restrictions.

post/v1/payment-codes

Headers

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

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

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

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.

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

Request body

mode'one_time' | 'recurrent'

Defines whether the payment code is single-use ('one_time') or reusable ('recurrent').

namestring nullable required

Descriptive name for the payment code, used for display or tracking.

enableboolean

Whether the payment code should be enabled for use on creation.

durationstring

How long the payment code remains valid before expiring.

referencestring nullable

Reference tag to associate with this payment code for reconciliation or tracking.

authorizedProvidersstring[] nullable

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

authorizedPhoneNumberstring

MSISDN of the mobile money account exclusively allowed to use this code.

financialAccountIdstring nullable

Financial account where collected funds are settled. Defaults to the main account if omitted.

metadataobject nullable

Optional metadata for attaching custom business context to the payment code.

Example request

{
  "name": "Home EDSA Meter Top-up",
  "duration": "1h30m",
  "customer": {
    "name": "Musa Kamara"
  },
  "recurrentPaymentTarget": {
    "expectedPaymentCount": 10
  }
}

Response

OK

successboolean

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