UpdatePayment | DreamClass

curl -X PATCH https://api.dreamclass.io/dreamclassapi/v1/financial/invoices/payment/1 \
     -H "dreamclass-secret-key: {{apiKey}}" \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "publicNotes": "Receipt 2026-0042 issued",
  "privateNotes": "Reconciled with the bank statement",
  "date": "2026-01-15"
}'

{
  "id": 63,
  "amount": 25.5,
  "publicNotes": "Receipt 2026-0042 issued",
  "privateNotes": "Reconciled with the bank statement",
  "paymentmethod": {
    "id": 2,
    "translation": "PAYMENTMETHODS.BANK",
    "logOnlyPaymentMethod": true,
    "institutionId": 1
  },
  "createdAt": "2025-09-18T11:58:12.448+00:00",
  "date": "2026-01-15",
  "invoiceId": 24,
  "status": 1,
  "paymentFees": 0
}

Update editable fields of a payment

Input variables

paymentId: id of the payment (path variable)
json representation of editable fields of a Payment
- publicNotes
- privateNotes
- date

For payment ids check the GetInvoicePayments endpoint.

Only those three fields are editable

Everything else on the payment is left as it is, including amount, paymentmethod and paymentFees.

In particular this endpoint cannot change a payment’s status. Settlement is the payment provider’s word: it moves only when Stripe/PayPal reports an outcome, or when the payment is refunded, because each of those also adjusts the invoice’s paidAmount to match. Annotating a declined attempt through this endpoint leaves it declined, as it should.

The response returns the full payment, so status, paymentFees and stripePaymentIntentId are shown even though they cannot be set.

Update editable fields of a payment Input variables - paymentId: id of the payment (path variable) - json representation of editable fields of a Payment - publicNotes - privateNotes - date For payment ids check the GetInvoicePayments endpoint. ## Only those three fields are editable Everything else on the payment is left as it is, including `amount`, `paymentmethod` and `paymentFees`. In particular **this endpoint cannot change a payment's `status`.** Settlement is the payment provider's word: it moves only when Stripe/PayPal reports an outcome, or when the payment is refunded, because each of those also adjusts the invoice's `paidAmount` to match. Annotating a declined attempt through this endpoint leaves it declined, as it should. The response returns the full payment, so `status`, `paymentFees` and `stripePaymentIntentId` are shown even though they cannot be set.

Path parameters

paymentIdstringRequired

Headers

Request

This endpoint expects an object.

publicNotesstringRequired

privateNotesstringRequired

datedateRequired

Response

idinteger

amountdouble

publicNotesstring

privateNotesstring

paymentmethodobject

createdAtdatetime

datedate

invoiceIdinteger

statusinteger

paymentFeesinteger

stripePaymentIntentIdanyOptional