DreamClass APIInvoices

GetPayment

View as Markdown
Get a single payment by its id. PaymentId: Check the GetInvoicePayments call ## Payment object fields - **status** — whether the payment settled. 1 VALID (settled), 2 INVALID (failed), 3 PENDING (in flight), 4 REFUNDED. May be absent on payments predating the field; treat absent as settled. - **paymentFees** — the online processing fee taken on top of `amount`, which never includes it. Stripe collects `amount + paymentFees` as a single charge, so this is what reconciles a payment against a Stripe payout. - **stripePaymentIntentId** — the Stripe PaymentIntent behind the payment, or null for a manually recorded one. All three are read-only: they report what the payment provider did and are never accepted in a request body. A payment existing does not mean money was received. A declined card records a payment row of its own, and only status 1 payments count towards the invoice's `paidAmount`. status 3 means a bank debit (ACH) is still clearing, which takes 3-5 business days.

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.

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
X-Content-Type-OptionsstringOptional
Cache-ControlstringOptional

Response

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