Update a payment

patch

https://api.cardda.com/v1/payments/{id}

Updates a payment / deposit ("abono").

Permitted fields

A non-staff company user (with access to the payment's company) may only edit
comments. The request is rejected with 401 Unauthorized only when comments is
absent from the body; if comments is present, any other (staff-only) fields sent
alongside it are silently dropped and the request succeeds with 200. The full set
of payment fields is editable only by Cardda staff (admin/superadmin).

Unlike the list/detail endpoints, the update response returns the bare payment
record: it does NOT include the amount money object or the ppo_allocations array.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The UUID of the payment (abono / deposit).

Body Params

Body to update a payment. For a non-staff company user, only comments may be
edited; the request is rejected with 401 only when comments is absent. Any
staff-only fields sent together with comments are silently ignored (the request
still succeeds). The additional fields below are accepted only for Cardda staff
(admin/superadmin).

comments

string

Free-text comment. This is the ONLY field a non-staff company user is permitted
to edit. A non-staff request that omits comments returns 401 Unauthorized;
extra keys sent alongside comments are dropped rather than rejected.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Finance endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

404

Payment not found (or outside the caller's company scope).

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated payment, returned as the bare record: the amount money object and the ppo_allocations array (present on the list/detail endpoints) are NOT included here.

401Unauthorized - missing/invalid token, or a non-staff user sent a body without the comments field.