Skip to navigation

UpdatePayment

View as Markdown

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

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Request

This endpoint expects an object.
publicNotesstringRequired
privateNotesstringRequired
datedateRequired

Response

OK
idinteger
amountdouble
publicNotesstring
privateNotesstring
paymentmethodobject
createdAtdatetime
datedate
invoiceIdinteger
statusinteger
paymentFeesinteger
stripePaymentIntentIdanyOptional