Payment | DreamClass | Documentation

Webhook related to payments, trigged 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

Webhook related to payments, trigged 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

Request

This endpoint expects an object.

idstringRequiredformat: "uuid"

dataobjectRequired

typestringRequired

tenantstringRequired

signaturestringRequired

timestampintegerRequired

Response

Successful response

1	curl -X POST https://https//https#post10 \
2	-H "Content-Type: application/json" \
3	-d '{
4	"id": "214fb720-2248-44e0-9bfd-72171f9e72de",
5	"data": {
6	"id": 5,
7	"amount": 300,
8	"createdAt": "2024-10-02T16:08:33.387+00:00",
9	"invoiceId": 16,
10	"publicNotes": "Sample note",
11	"privateNotes": "Sample note",
12	"paymentmethod": {
13	"id": 1,
14	"logOnlyPaymentMethod": true
15	}
16	},
17	"type": "PAYMENT_CREATED",
18	"tenant": "my-school",
19	"signature": "b2fl8PdPRVsq0vre6DpdHJwHse8Ln+WlY0Vx32aKxtE=",
20	"timestamp": 1727885313393
21	}'