Update a payment

Operation ID: updatePayment

Group: Accounting › Payments

Open in the interactive reference

PATCH /accounting/payments/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a payment with the fields you send. A field you leave out keeps its current value. To clear paymentReference, paymentNote, bankFeeAmount, or thirdPartyPayerId, send null.

Use the payment's id, not its paymentNumber.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the payment you want to update.

Request body

Required, application/json: updatePaymentInput.

Field Type Required Description
paymentDate date no The new payment date. Use format YYYY-MM-DD. Omit to leave it unchanged.
paymentType any no The new payment method. Omit to leave it unchanged. One of: "check", "ach", "wire", "creditCard", "directDebit", "sepaCreditTransfer".
amount decimal no The new total payment amount, in the payment's currency. Must be greater than 0. Omit to leave it unchanged.
accountId string no A different ledger account to post the payment to. Omit to leave it unchanged. See id on GET accounting/accounts/:id.
paymentReference string | null no A new payer-supplied reference. Omit to leave it unchanged. Pass null to clear it.
paymentNote string | null no A new free-form note. Omit to leave it unchanged. Pass null to clear it.
bankFeeAmount decimal | null no A new bank fee, in the payment's currency. Omit to leave it unchanged. Pass null to clear it.
thirdPartyPayerId string | null no A different third-party payer. Omit to leave it unchanged. Pass null to clear it, attributing the payment back to the invoiced customer. See id on GET accounting/customers/:id. 
{
  "paymentDate": "2026-01-15",
  "paymentType": "check",
  "amount": "19.99",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "paymentReference": "<paymentReference>",
  "paymentNote": "<paymentNote>",
  "bankFeeAmount": "19.99",
  "thirdPartyPayerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
INVALID_AMOUNT 400
ACCOUNT_NOT_FOUND 400
THIRD_PARTY_PAYER_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses