Skip to content

docs(payments): document webhook-delivered payment events #865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jambox11 merged 1 commit into from
Sep 4, 2026
Merged

docs(payments): document webhook-delivered payment events #865

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,22 @@ Set `FEATURE_MAINNET_PAYMENT_SUBMIT=true` in your production environment only af

See [Mainnet Payment Feature Flag](docs/MAINNET-PAYMENT-FEATURE-FLAG.md) for full operational guidance.

### Webhook-Delivered Payment Events

Payment domain events are bridged to the outbound webhook system via
`PaymentWebhookListener`. When the `PaymentsService` emits an internal event,
the listener forwards it to `WebhookEventEmitterService` for delivery to
registered webhook endpoints.

| Internal event | Webhook event type | Trigger |
|--------------------|----------------------|---------|
| `payment.created` | `payment.created` | New payment created |
| `payment.completed`| `payment.completed` | Payment confirmed |
| `payment.failed` | `payment.failed` | Payment failed |

Webhook dispatch errors are logged but never propagated to the caller, so
payment operations are not blocked by downstream webhook failures.

### 馃 Account Abstraction Layer

* User identity mapped to blockchain accounts
Expand Down