Payment events fire in response to payment processing outcomes in DDLS.
Events #
payment.received #
Fired when: A payment is successfully processed.
DDLS Hook: dmsi_payment_received
Typical payload data fields:
| Field | Type | Description |
|---|---|---|
order_id | integer | Associated order ID |
customer | object | Customer info: {id, email} |
license_key | string | Associated license key |
amount | string | Payment amount (formatted as decimal string) |
currency | string | ISO 4217 currency code (e.g., USD) |
payment_method | string | Payment gateway used |
received_at | string | Payment timestamp (ISO 8601) |
—
payment.failed #
Fired when: A payment attempt fails or is declined.
DDLS Hook: dmsi_payment_failed
Typical payload data fields:
| Field | Type | Description |
|---|---|---|
order_id | integer | Associated order ID |
customer | object | Customer info: {id, email} |
license_key | string | Associated license key |
amount | string | Attempted amount |
currency | string | ISO 4217 currency code |
payment_method | string | Payment gateway |
failure_reason | string | Failure reason from gateway |
failed_at | string | Failure timestamp (ISO 8601) |
—
Use Cases #
- Trigger subscription activation in an external billing system on
payment.received - Send a dunning email from a CRM system on
payment.failed - Update revenue analytics on
payment.received - Alert support on
payment.failedfor high-value orders
Related Topics #
- Event Types Overview
- License Events
- Payload Reference
