PATCH
Update payment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payment_id
string<uuid>
required

Payment ID

Body

application/json

JSON payload used to update payment.

A recorded payment is an accounting voucher: amount and payment_date are immutable after creation (ADR 0019) and are intentionally absent here, so the API has no way to restate or back-date a posted payment. Correct a wrong amount/date by reversing the payment and recording a new one. Only the annotative method and note are editable.

method
null | enum<string>

Payment method used for the payment.

Available options:
cash,
bank_transfer,
other
note
string | null

Optional note captured by the operator.

Maximum string length: 1000

Response

Updated payment

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.