Skip to navigation

Payment

View as Markdown

DreamClass sends this request to you. The URL and server shown above are a placeholder for the endpoint you register under Settings > Integrations. They are not DreamClass addresses and there is nothing here for you to call. Webhook related to payments, triggered upon

  • Payment created: PAYMENT_CREATED

  • Payment updated: PAYMENT_UPDATED

  • Payment deleted: PAYMENT_DELETED

Using the provided invoiceId, use the GetInvoice API to retrieve more data. Using the provided paymentmethod.id use the GetPaymentMethods to retrieve more data

status:
VALID: 1
INVALID: 2
PENDING: 3
REFUNDED: 4

A payment’s status changes over its life, and each change is delivered here. A card charge that is declined arrives as PAYMENT_CREATED with status 2. A bank debit (ACH) arrives as status 3 and then, days later, as PAYMENT_UPDATED with status 1 once it clears — or status 2 if it bounces. A refund arrives as PAYMENT_UPDATED with status 4.

Only status 1 payments count towards the invoice’s paidAmount, so a consumer summing webhook payloads should sum status 1 alone.

The REST payment object additionally carries paymentFees (the online processing fee taken on top of amount) and stripePaymentIntentId. Neither is included in this webhook payload — fetch them with GetPayment or GetInvoicePayments if you need them.

Request

This endpoint expects an object.
tenantstringRequired
timestampintegerRequired
idstringRequiredformat: "uuid"
signaturestringRequired
typestringRequired
dataobjectRequired

Response

Successful response