For the complete documentation index, see llms.txt. This page is also available as Markdown.

Overview

The widget's home screen offers several ways for a user to fund your destination: three methods shown by default, plus opt-in source flows you enable explicitly. This section explains what each one does, what the user experiences, and what your app receives.

You control which appear with supportedDepositOptions; omit it to show the default set.

The default methods

Method
Key
User pays with
Best when

depositWithCash

Card / Apple Pay / bank (fiat)

Users have no crypto yet.

transferCrypto

A one-tap smart-wallet deposit

Lowest-friction on-chain funding.

walletDeposit

Tokens in their own wallet, any chain

Crypto-native users.

All three converge on the same outcome: your dstTokenAddr on dstChainId, delivered to depositWalletAddress.

Opt-in source flows

Two additional funding sources, off by default — enable them explicitly in supportedDepositOptions. Each pulls the user's balance from that platform and swaps/bridges it to your destination token, much like Wallet Deposit but sourced from a specific platform account rather than a connected wallet.

Method
Key
Source

Deposit from Polymarket

depositFromPolymarket

The user's Polymarket USDC balance

Deposit from Perps

depositFromPerps

The user's balance on a supported perps venue

How they map to a deposit's method

When a deposit completes, its record (in webhooks) carries a method field. It relates to the widget option like so:

Widget option

Deposit method

depositWithCash

onramp (and, if swept onward, a linked smart_wallet)

transferCrypto

smart_wallet

walletDeposit

dex_swap

The onramp-plus-sweep case produces two linked deposits — see Webhooks → Linking.

Amounts and limits

Choosing what to show

  • Consumer app, mainstream users → lead with depositWithCash; the one-tap transferCrypto is also low-friction. Keep walletDeposit for crypto-native users who prefer their own wallet.

  • DeFi / on-chain productwalletDeposit and transferCrypto.

  • Not sure → show the default set and let users pick.

  • Built on Polymarket or a perps venue? → enable the matching opt-in source flow so users can fund straight from their platform balance.

Read the per-method pages for the details:

Last updated