> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hel.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Deposit Payload Reference
> JSON payload reference for deposit webhook events and alerts
JSON bodies delivered for deposit webhook events. For events, setup, and delivery rules, see [Deposit webhooks](/reference/webhook/deposit/overview). See [Webhook request headers](/reference/webhook/overview#webhook-request-headers) for delivery headers.
## Below-Minimum Deposit Alerts
```json JSON theme={null}
{
"event": "DEPOSIT_BELOW_MINIMUM", // Webhook event type
"depositId": "6655001000000000000000c1", // Unique deposit identifier
"customerId": "merchant-customer-1", // Merchant-defined customer identifier
"depositWalletAddress": "Cq9f4fhen7ovueaa3Ug44RE2nEJSPhD41NV5HpLpjgGG", // Deposit wallet public key
"currency": { // Source asset on the deposit wallet (what the user sent)
"id": "6340313846e4f91b8abc519b",
"name": "USD Coin",
"decimals": 6,
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"coinMarketCapId": 3408,
"symbol": "USDC",
"blockchain": {
"id": "6340313846e4f91b8abc515c",
"name": "SOL",
"symbol": "SOL"
}
},
"originalAmount": "3000000", // Current wallet balance, source-currency minimal units
"originalAmountInUSD": "3000000", // Current balance in USDC minimal units (6 decimals)
"minimumAmount": "10000000", // Required minimum in source-currency minimal units
"minimumAmountInUSD": "10000000", // Required minimum in USDC minimal units (6 decimals)
"amount": "0", // Not a settled deposit — always zero
"feesPaid": "0",
"gasCharge": "0",
"grossAmount": "0",
"webhookDeliveryIdempotencyKey": "DEPOSIT_BELOW_MINIMUM:6655001000000000000000f1",
"txIdempotencyKey": "6655001000000000000000f1" // Per-fire notification id (same value in X-Transaction-Id)
}
```
## Under-Review Deposit Alerts
```json JSON theme={null}
{
"event": "DEPOSIT_UNDER_REVIEW", // Webhook event type
"depositId": "6655001000000000000000c1", // Unique deposit identifier
"customerId": "merchant-customer-1", // Merchant-defined customer identifier
"depositWalletAddress": "Cq9f4fhen7ovueaa3Ug44RE2nEJSPhD41NV5HpLpjgGG", // Deposit wallet public key
"currency": { // Source asset on the deposit wallet
"id": "6340313846e4f91b8abc519b",
"name": "USD Coin",
"decimals": 6,
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"coinMarketCapId": 3408,
"symbol": "USDC",
"blockchain": {
"id": "6340313846e4f91b8abc515c",
"name": "SOL",
"symbol": "SOL"
}
},
"amount": "0", // Not a settled deposit — always zero
"feesPaid": "0",
"gasCharge": "0",
"grossAmount": "0",
"webhookDeliveryIdempotencyKey": "DEPOSIT_UNDER_REVIEW:6655001000000000000000f1",
"txIdempotencyKey": "6655001000000000000000f1" // Deposit wallet id (same value in X-Transaction-Id)
}
```
## Deposit-Customer Quota Alerts
The `event` field is one of `DEPOSIT_CUSTOMER_QUOTA_WARNING`, `DEPOSIT_CUSTOMER_QUOTA_CRITICAL`, or `DEPOSIT_CUSTOMER_QUOTA_REACHED`.
```json JSON theme={null}
{
"event": "DEPOSIT_CUSTOMER_QUOTA_WARNING", //Alert type
"companyId": "6343e77d91c393456aa56462", // Company identifer
"currentCount": 800, // Customers created today
"dailyLimit": 1000, // Daily creation limit
"percentUsed": 80, // Percentage of limit used
"resetsAt": "2026-05-24T00:00:00.000Z", //UTC reset time
"webhookDeliveryIdempotencyKey": "DEPOSIT_CUSTOMER_QUOTA_WARNING:6343e77d91c393456aa56462:2026-05-24T00:00:00.000Z"
}
```
## Deposit Transaction Events
```json DEPOSIT_TX_SUBMITTED theme={null}
{
"event": "DEPOSIT_TX_SUBMITTED",
"depositId": "dep_1234567890",
"customerId": "cust_abc123",
"amount": "343000000",
"feesPaid": "7000000",
"gasCharge": "0",
"grossAmount": "350000000",
"currency": {
"id": "currency_sol_id",
"name": "Solana",
"decimals": 9,
"mintAddress": "11111111111111111111111111111111",
"coinMarketCapId": 5426,
"symbol": "SOL",
"blockchain": {
"id": "blockchain_sol_id",
"name": "SOL",
"symbol": "SOL"
}
},
"originalAmount": "343000000",
"originalCurrency": {
"id": "currency_sol_id",
"name": "Solana",
"decimals": 9,
"symbol": "SOL",
"blockchain": {
"id": "blockchain_sol_id",
"name": "SOL",
"symbol": "SOL"
}
},
"webhookDeliveryIdempotencyKey": "DEPOSIT_TX_SUBMITTED:tx_meta_abc123",
"txIdempotencyKey": "tx_meta_abc123",
"submittedTransactionIdempotencyKey": "submitted_tx_abc123",
"transactionObject": {
"id": "txn_1234567890",
"fee": "7000000",
"createdAt": "2026-02-13T16:35:27.561Z",
"paymentType": "DEPOSIT",
"meta": {
"id": "tx_meta_abc123",
"amount": "343000000",
"transactionSignature": "0xTransactionHashOrSignatureHere",
"transactionStatus": "SUCCESS"
}
},
"transaction": "{\"id\":\"txn_1234567890\"...}"
}
```
```json DEPOSIT_TX_SUBMITTED (swap-only) theme={null}
{
"event": "DEPOSIT_TX_SUBMITTED",
"depositId": "dep_1234567890",
"customerId": "cust_abc123",
"amount": "343000000",
"feesPaid": "7000000",
"gasCharge": "0",
"grossAmount": "350000000",
"currency": { "...": "..." },
"originalAmount": "4993316380000000",
"originalAmountInUSD": "3072627",
"originalCurrency": { "...": "..." },
"webhookDeliveryIdempotencyKey": "DEPOSIT_TX_SUBMITTED:sweep_details_abc123",
"txIdempotencyKey": "sweep_details_abc123",
"submittedTransactionIdempotencyKey": "sweep_details_abc123"
}
```
```json DEPOSIT_TX_CONFIRMED theme={null}
{
"event": "DEPOSIT_TX_CONFIRMED", // Webhook event type
"depositId": "dep_1234567890", // Unique deposit identifier
"customerId": "cust_abc123", // Customer identifier (provided by merchant / integrator)
"amount": "35328965", // Final settled destination amount (source of truth)
"feesPaid": "706579", // Total fees charged, in smallest unit
"gasCharge": "0", // Gas fee charged (if applicable), in smallest unit
"grossAmount": "36035544", // Final destination amount before fees
"currency": { // Destination currency (what the customer receives)
"id": "currency_sol_id", // Internal currency ID
"name": "Solana", // Currency name
"decimals": 9, // Currency decimals
"mintAddress": "11111111111111111111111111111111", // Token mint address (native SOL shown here)
"coinMarketCapId": 5426, // CoinMarketCap ID
"symbol": "SOL", // Currency symbol
"blockchain": {
"id": "blockchain_sol_id", // Internal blockchain ID
"name": "SOL", // Blockchain name
"symbol": "SOL" // Blockchain symbol
}
},
"originalAmount": "4993316380000000", // Original received amount (source), in smallest unit of originalCurrency
"originalAmountInUSD": "3072627", // USD value of originalAmount at time of processing (smallest USD unit, e.g. cents * 100)
"originalCurrency": { // Source currency (what the user originally sent)
"id": "currency_bnb_id", // Internal currency ID
"name": "BNB", // Currency name
"decimals": 18, // Currency decimals
"mintAddress": "0x0000000000000000000000000000000000000000", // Token contract address (or native placeholder)
"coinMarketCapId": 1839, // CoinMarketCap ID
"symbol": "BNB", // Currency symbol
"blockchain": {
"id": "blockchain_bsc_id", // Internal blockchain ID
"name": "BSC", // Blockchain name
"symbol": "BSC" // Blockchain symbol
}
},
"webhookDeliveryIdempotencyKey": "DEPOSIT_TX_CONFIRMED:tx_abc123", // Idempotency key for webhook delivery
"txIdempotencyKey": "tx_abc123", // Idempotency key for the transaction
"submittedTransactionIdempotencyKey": "submitted_tx_abc123", // Idempotency key for submitted transaction (if applicable)
"transactionObject": { // Transaction details object
"id": "txn_1234567890", // Internal transaction ID
"fee": "706579", // Fee amount in smallest unit
"createdAt": "2026-02-13T16:35:27.561Z", // Timestamp of transaction creation
"paymentType": "DEPOSIT", // Payment type classification
"meta": {
"id": "tx_meta_abc123", // Internal transaction meta ID
"amount": "35328965", // Deposited amount, in smallest unit
"senderPK": "0xSenderWalletAddressHere", // Sender wallet address
"recipientPK": "RecipientWalletAddressHere", // Recipient wallet address
"transactionType": "DEPOSIT", // Transaction type
"currency": { // Destination currency object (same as top-level currency)
"id": "currency_sol_id",
"name": "Solana",
"decimals": 9,
"mintAddress": "11111111111111111111111111111111",
"coinMarketCapId": 5426,
"symbol": "SOL",
"blockchain": {
"id": "blockchain_sol_id",
"name": "SOL",
"symbol": "SOL"
}
},
"transactionSignature": "0xTransactionHashOrSignatureHere", // Blockchain tx hash/signature
"customerDetails": null, // Optional customer metadata (can be null)
"productDetails": {}, // Optional product metadata
"transactionStatus": "SUCCESS", // Transaction status
"totalAmount": "35328965" // Total processed amount, in smallest unit
}
},
"transaction": "{\"id\":\"txn_1234567890\"...}" // Stringified version of transactionObject (legacy/compat)
}
```
```json DEPOSIT_TX_ENRICHED theme={null}
{
"event": "DEPOSIT_TX_ENRICHED", // Webhook event type
"depositId": "69861e434e3b4725275f1e14", // Unique deposit identifier
"customerId": "test", // Customer identifier
"amount": "3919234", // Net deposited amount (after fees), in smallest currency unit
"feesPaid": "78384", // Fees charged, in smallest currency unit
"gasCharge": "0", // Gas fee charged (if applicable), in smallest currency unit
"grossAmount": "3997618", // Total amount including fees, in smallest currency unit
"currency": {
"id": "6340313846e4f91b8abc519b", // Internal currency ID
"name": "USD Coin", // Currency name
"decimals": 6, // Currency decimals
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", // Token mint address
"coinMarketCapId": 3408, // CoinMarketCap ID
"symbol": "USDC", // Currency symbol
"blockchain": {
"id": "6340313846e4f91b8abc515c", // Internal blockchain ID
"name": "SOL", // Blockchain name
"symbol": "SOL" // Blockchain symbol
}
},
"originalAmount": "46185585", // Original received amount (before conversion), in smallest unit of originalCurrency
"originalAmountInUSD": "3997651", // USD value of originalAmount at time of processing, in cents (or smallest USD unit)
"originalCurrency": {
"id": "6340313846e4f91b8abc5195", // Internal currency ID of original asset
"name": "Solana", // Original asset name
"decimals": 9, // Original asset decimals
"mintAddress": "11111111111111111111111111111111", // Original asset mint address
"coinMarketCapId": 5426, // CoinMarketCap ID
"symbol": "SOL", // Original asset symbol
"blockchain": {
"id": "6340313846e4f91b8abc515c", // Blockchain ID
"name": "SOL", // Blockchain name
"symbol": "SOL" // Blockchain symbol
}
},
"transactionObject": {
"id": "69861ef6cec1fd89b559a8a7", // Internal transaction ID
"fee": "78384", // Transaction fee, in smallest currency unit
"createdAt": "2026-02-06T17:03:50.641Z", // Transaction creation timestamp (ISO 8601)
"paymentType": "DEPOSIT", // Payment type classification
"meta": {
"id": "69861ef6cec1fd89b559a8a5", // Internal transaction meta ID
"amount": "3919234", // Deposited amount, in smallest currency unit
"senderPK": "Cq9f4fhen7ovueaa3Ug44RE2nEJSPhD41NV5HpLpjgGG", // Sender wallet address
"recipientPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW", // Recipient wallet address
"transactionType": "DEPOSIT", // Transaction type
"currency": {
"id": "6340313846e4f91b8abc519b", // Currency ID
"name": "USD Coin", // Currency name
"decimals": 6, // Currency decimals
"mintAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", // Token mint address
"coinMarketCapId": 3408, // CoinMarketCap ID
"symbol": "USDC", // Currency symbol
"blockchain": {
"id": "6340313846e4f91b8abc515c", // Blockchain ID
"name": "SOL", // Blockchain name
"symbol": "SOL" // Blockchain symbol
}
},
"transactionSignature": "2NPEMm7XEgz2Hcr3fZ4KdqE6bjxz887YF9vFssipXg1UY5tUtzR8cSbENjHY8ij7qLQMp4VCQqPK18vAwkedkRg1", // Blockchain transaction signature/hash
"customerDetails": {
"additionalJSON": "testing" // Customer metadata (custom field)
},
"productDetails": {}, // Product metadata (if applicable)
"transactionStatus": "SUCCESS", // Transaction status
"totalAmount": "3919234" // Total processed amount, in smallest currency unit
}
},
"transaction": "{\"id\":\"69861ef6cec1fd89b559a8a7\"...}", // Stringified JSON version of transactionObject (legacy/compat)
"webhookDeliveryIdempotencyKey": "DEPOSIT_TX_ENRICHED:69861ef6cec1fd89b559a8a5", // Idempotency key for webhook delivery
"txIdempotencyKey": "69861ef6cec1fd89b559a8a5", // Idempotency key for the transaction
"incomingTransactions": [
{
"hash": "4zig5GYQzkJwf2N36X4CuYejCasCcEgnbBmGxQWn32a6S3aJa4RT6cDHweDvr73BNVqKWHdfpNPaH9NK1AJXN57N", // On-chain transaction hash
"from": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW", // Sender address
"to": "Cq9f4fhen7ovueaa3Ug44RE2nEJSPhD41NV5HpLpjgGG", // Recipient address
"value": "46185585", // Amount transferred, in smallest unit of originalCurrency
"blockNumber": 398484220, // Block/slot number
"timestamp": 1770397408, // Transaction timestamp (unix epoch seconds)
"status": "success", // On-chain execution status
"gasUsed": "5000", // Gas/compute units used (chain-specific)
"valueInUSD": "3997651",
"timestampMs": 1770397408000,
"gasPrice": "1",
"nonce": 42,
"paymentMethod": "CRYPTO",
"refunded": false,
"refundTransactionSignature": null
}
]
}
```
Each item in `incomingTransactions` may also include optional fields: `valueInUSD`, `timestampMs`, `gasPrice`, `nonce`, `paymentMethod`, `refunded`, `refundTransactionSignature`, and `currency`. The `to` field may be `null`.