Skip to content

Commit 9a10e5a

Browse files
committed
fix: webhook event type tables
1 parent 6cae89c commit 9a10e5a

File tree

1 file changed

+4
-47
lines changed

1 file changed

+4
-47
lines changed

api-reference/webhooks.mdx

Lines changed: 4 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ ngrok http 3000
3131
|-------|-------------|---------|-------------|
3232
| `payment.confirmed` | Payment fully completed and settled | After blockchain confirmation | Complete fulfillment, release goods |
3333
| `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 |
34+
| `payment.failed` | Payment execution failed | Recurring payments, cross-chain transfers | Notify failure, retry logic, pause subscriptions |
35+
| `payment.refunded` | Payment has been refunded to payer | Cross-chain payment failures, refund scenarios | Update order status, notify customer |
3636

3737
### Processing Events
3838

3939
| Event | Description | Context | Primary Use |
4040
|-------|-------------|---------|-------------|
41-
| `payment.processing` | Crypto-to-fiat conversion in progress | Stages: initiated, pending_assessment, ongoing_checks, sending_fiat, fiat_sent | Track conversion status, update UI |
41+
| `payment.processing` | Crypto-to-fiat payment in progress | **subStatus values:** initiated, pending_internal_assessment, ongoing_checks, sending_fiat, fiat_sent, bounced | Track crypto-to-fiat payment status, update UI |
4242

4343
### Request Events
4444

@@ -50,52 +50,9 @@ ngrok http 3000
5050

5151
| Event | Description | Context | Primary Use |
5252
|-------|-------------|---------|-------------|
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 |
53+
| `compliance.updated` | KYC or agreement status changed | **kycStatus values:** not_started, pending, approved, rejected, retry_required<br/>**agreementStatus values:** not_started, pending, completed, rejected, failed | Update user permissions, notify status |
5454
| `payment_detail.updated` | Bank account verification status updated | States: approved, failed, pending | Enable fiat payments, update profiles |
5555

56-
### Processing Events
57-
<CardGroup cols={2}>
58-
<Card title="payment.processing" icon="spinner">
59-
Crypto-to-fiat conversion in progress
60-
61-
**Stages:** initiated, pending_assessment, ongoing_checks, sending_fiat, fiat_sent
62-
**Use:** Track conversion status, update UI
63-
</Card>
64-
</CardGroup>
65-
66-
### Request Events
67-
<CardGroup cols={2}>
68-
<Card title="request.recurring" icon="repeat">
69-
New recurring request generated
70-
71-
**Context:** Subscription renewals, scheduled payments
72-
**Use:** Send renewal notifications, update billing
73-
</Card>
74-
</CardGroup>
75-
76-
### Compliance Events
77-
<CardGroup cols={2}>
78-
<Card title="compliance.updated" icon="shield-check">
79-
KYC or agreement status changed
80-
81-
**KYC States:** initiated, pending, approved, rejected, failed
82-
**Agreement States:** not_started, pending, completed, rejected, failed
83-
**Use:** Update user permissions, notify status
84-
</Card>
85-
86-
<Card title="payment_detail.updated" icon="building-columns">
87-
Bank account verification status updated
88-
89-
**States:** approved, failed, pending
90-
**Use:** Enable fiat payments, update profiles
91-
- Updated fields
92-
- Previous values
93-
- Change timestamp
94-
95-
**Use Cases:** Audit trails, status synchronization
96-
</Card>
97-
</CardGroup>
98-
9956
## Security Implementation
10057

10158
### Signature Verification

0 commit comments

Comments
 (0)