POST /setup to configure how the deposit service handles your deposits. All fields are optional — configure what you need. Each call performs a partial update; omitted fields keep their current value.
All examples below use these shared constants:
Configure a webhook
Register a URL to receive notifications about deposit events. Optionally provide a secret for HMAC-SHA256 signature verification.webhookSecret is set, every webhook request includes an X-Webhook-Signature header you can verify. See webhooks for event types, payload format, and verification examples.
Sponsor fees
Cover gas, bridging, and swap fees on behalf of your users so they receive the full deposit amount. Sponsorship is configured per source chain using CAIP-2 identifiers. Chains without explicit config default to no sponsorship.Restrict accepted deposits
Define a whitelist of accepted tokens per source chain. Deposits of unlisted tokens are silently ignored. You can also set minimum and maximum deposit amounts per token.| Field | Type | Description |
|---|---|---|
token | string | Token address (0x-prefixed) |
minAmount | string | Optional. Minimum accepted amount in raw token units (inclusive) |
maxAmount | string | Optional. Maximum accepted amount in raw token units (inclusive) |
bridge-failed webhook with error code TOKEN-3 (token not allowed) or BALANCE-3 (amount out of range).
Set price deviation tolerance
For stablecoin-to-stablecoin bridges, set the maximum allowed price deviation in basis points. Deposits that exceed this threshold are rejected with error codeBRIDGE-5.
200 (2%) if not set. Tighten this for high-value stablecoin corridors; loosen it if you see rejections during volatile periods.
Clear a configuration field
Each/setup call is a partial update. To explicitly clear a field, pass null for string fields or {} for object fields:
| To clear | Pass |
|---|---|
webhookUrl | null |
webhookSecret | null |
sponsorship | {} |
depositWhitelist | {} |
maxPriceDeviationBps | null |
Put it all together
A single/setup call configuring everything at once: