Skip to main content
PATCH
Patch Payment

Authorizations

Authorization
string
header
required

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

Headers

Monime-Version
enum<string> | null

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

Available options:
caph.2025-08-23,
caph.2025-06-20
Monime-Space-Id
string
required

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

Maximum string length: 64
Pattern: ^spc-.*$

Path Parameters

id
string
required

ID of the payment object to update.

Body

application/json

Updates mutable fields of a payment object like name, description, or metadata.

name
string | null

New label for the payment. Useful for reclassifying or tagging.

Maximum string length: 100
metadata
object | null

Structured metadata to enrich or tag the payment.

Response

200 - application/json

OK

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 · object

A Payment represents a customer payment made through Monime’s platform.
It captures high-level information about the user-initiated payment, including the amount, status, channel (e.g., Mobile Money, Card, Bank), associated order, fees applied, and links to downstream financial transactions.

The Payment is a business object — the single record developers and merchants interact with when tracking or reconciling user payments.
It should not be confused with Financial Transactions, which are lower-level, fine-grained ledger entries.
In fact, one Payment usually generates multiple Financial Transactions — for example:

  • A credit of the received funds into the merchant’s account.
  • One or more debits representing platform charges or processing fees.