Sign in

v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
Payment Code

Update Payment Code

Partially updates an existing payment code with new values, rules, or account bindings.

patch/v1/payment-codes/{id}

Path parameters

idstring required

The unique ID of the payment code to update.

The unique ID of the payment code to update.

Headers

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

namestring nullable

Updated display name or label for the payment code.

durationstring nullable

New expiration duration for the code.

enableboolean nullable

Flag to activate or deactivate the payment code.

referencestring nullable

New reference string for tagging the payment code.

authorizedProvidersstring[] nullable

Updated list of mobile money providers allowed to use this code.

authorizedPhoneNumberstring nullable

New MSISDN authorized to use this payment code exclusively.

financialAccountIdstring nullable

Updated destination financial account for funds settlement.

metadataobject nullable

Updated metadata for storing additional context about the payment code.

Example request

{
  "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