Sign in
Payment

Update a payment

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.

patch/v1/payments/{id}

Path parameters

idstring uuid required

The UUID of the payment (abono / deposit).

Parameters

#/paths/~1v1~1bills/get/parameters/0 — unresolved $ref

Request body

commentsstring

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.

Example request

{
  "comments": "Abono correspondiente a la factura 1234"
}

Response

The 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.

idstring uuid required
company_idstring uuid nullable
user_idstring nullable
kindstring

Payment kind (e.g. received, sent, reversal variants).

amount_centsinteger nullable
currencystring nullable
payment_typestring nullable
descriptionstring nullable
commentsstring

Free-text comment. The only field a non-staff company user may edit.

commentstring nullable
reference_idstring nullable
external_idstring nullable
bank_idstring nullable
conciliatedboolean nullable
verifiedboolean
recipient_accountobject nullable
sender_accountobject nullable
transaction_datestring date-time nullable
post_datestring date-time nullable
created_atstring date-time
updated_atstring date-time

Example response

{
  "kind": "received",
  "currency": "CLP"
}

Changes