@@ -12,7 +12,7 @@ Webhooks deliver real-time notifications when payment and request events occur.
12
12
### Setup in Portal
13
13
1 . Navigate to ** Platform Settings → Webhooks** in Request Portal
14
14
2 . Click ** Add webhook**
15
- 3 . Enter URL and click ** Create webhook**
15
+ 3 . In the dialog that opens, enter URL and click ** Create webhook**
16
16
4 . Click copy button to copy ** Signing Secret** to clipboard
17
17
5 . Enable/disable or delete webhooks as needed
18
18
@@ -26,35 +26,32 @@ ngrok http 3000
26
26
## Event Types
27
27
28
28
### Payment Events
29
- <CardGroup cols = { 2 } >
30
- <Card title = " payment.confirmed" icon = " circle-check" >
31
- Payment fully completed and settled
32
-
33
- ** Timing:** After blockchain confirmation
34
- ** Use:** Complete fulfillment, release goods
35
- </Card >
36
-
37
- <Card title = " payment.partial" icon = " clock" >
38
- Partial payment received for request
39
-
40
- ** Scenarios:** Installments, partial orders
41
- ** Use:** Update balance, allow additional payments
42
- </Card >
43
-
44
- <Card title = " payment.failed" icon = " circle-x" >
45
- Payment transaction failed or reverted
46
-
47
- ** Triggers:** Failed TX, insufficient funds
48
- ** Use:** Notify failure, reset order status
49
- </Card >
50
-
51
- <Card title = " payment.refunded" icon = " arrow-uturn-left" >
52
- Payment has been refunded to payer
53
-
54
- ** Context:** Crypto-to-fiat transactions
55
- ** Use:** Update order status, notify customer
56
- </Card >
57
- </CardGroup >
29
+
30
+ | Event | Description | Context | Primary Use |
31
+ | -------| -------------| ---------| -------------|
32
+ | ` payment.confirmed ` | Payment fully completed and settled | After blockchain confirmation | Complete fulfillment, release goods |
33
+ | ` payment.partial ` | Partial payment received for request | Installments, partial orders | Update balance, allow additional payments |
34
+ | ` payment.failed ` | Payment transaction failed or reverted | Failed TX, insufficient funds | Notify failure, reset order status |
35
+ | ` payment.refunded ` | Payment has been refunded to payer | Crypto-to-fiat transactions | Update order status, notify customer |
36
+
37
+ ### Processing Events
38
+
39
+ | Event | Description | Context | Primary Use |
40
+ | -------| -------------| ---------| -------------|
41
+ | ` payment.processing ` | Crypto-to-fiat conversion in progress | Stages: initiated, pending_assessment, ongoing_checks, sending_fiat, fiat_sent | Track conversion status, update UI |
42
+
43
+ ### Request Events
44
+
45
+ | Event | Description | Context | Primary Use |
46
+ | -------| -------------| ---------| -------------|
47
+ | ` request.recurring ` | New recurring request generated | Subscription renewals, scheduled payments | Send renewal notifications, update billing |
48
+
49
+ ### Compliance Events
50
+
51
+ | Event | Description | Context | Primary Use |
52
+ | -------| -------------| ---------| -------------|
53
+ | ` compliance.updated ` | KYC or agreement status changed | ** KYC:** initiated, pending, approved, rejected, failed<br />** Agreement:** not_started, pending, completed, rejected, failed | Update user permissions, notify status |
54
+ | ` payment_detail.updated ` | Bank account verification status updated | States: approved, failed, pending | Enable fiat payments, update profiles |
58
55
59
56
### Processing Events
60
57
<CardGroup cols = { 2 } >
0 commit comments