backendUrl. There is no default — point it at a proxy you run, on your own key.
Two ways to get one:
- Deploy Rhinestone’s. Open source and configurable — see deploy the Rhinestone proxy.
- Write your own. A route table and a header — see minimal proxy.
Deploy the Rhinestone proxy
rhinestonewtf/deposit-widget-proxy is the proxy Rhinestone runs, packaged so you can deploy it as-is. It covers every route in the table below, and adds regional payment methods — which a hand-written proxy can’t do, since resolving the user’s country needs the edge that actually sees them.
It needs one variable — your API key:
backendUrl at it and check GET /health. Everything else is optional and documented in the repository’s README:
Minimal proxy
A proxy is an explicit route table plus a header. The allowlist is the security boundary — see the warning below. For modal versions that use/assets, your proxy must forward both GET /assets and QUERY /assets. Allow QUERY in CORS preflight and forward its JSON body unchanged.
Bank transfers need provisioning first
The modal can offer bank transfers: the user gets a virtual bank account in their name, wires fiat to it, and the deposit lands on chain like any other. It needs@rhinestone/deposit-modal 0.21.0 or later, and is off by default. Enabling it takes two steps: the bank transfer provider
passes your business through its KYB review, then Rhinestone turns virtual
accounts on for your organization. Contact us
to start. Until then the modal offers card and exchange funding only, even with
virtualAccountOnramp set.
Once enabled, add one authenticated endpoint to your application’s backend.
It identifies the signed-in customer and checks that they may use the requested
deposit account. The modal calls it through the getCustomerSession prop.
This exchange needs a stable customer ID from your application and the registered
deposit account address, not the customer’s name, bank details or KYC documents.
The customer completes identity verification through the provider’s flow in the modal.
Backend: authorize the customer and account
UsecreateCustomerSessionHandler from @rhinestone/deposit-modal/server.
The following example uses a Next.js route handler; the helper itself accepts
and returns standard Web Request and Response objects.
requireUser and findDepositAccountForUser below represent your application’s
authentication and ownership lookup, not Rhinestone SDK functions. The lookup
must establish that this user is authorized for this deposit account; checking
only that the account belongs to your project is insufficient.
app/api/customer-session/route.ts
POST /compliance/sessions server-side with your API key and
the identifiers returned by authorize. Rhinestone creates or resumes that
customer, binds the deposit account to it, and issues a 15-minute token scoped
to the customer, project and bound account. A customer has one bound account,
because its bank details pay into one address; a session for another of the
user’s deposit accounts is refused with ACCOUNT_CHANGE_REQUIRES_MIGRATION. The helper returns only { token, expiresAt } to the browser, with
Cache-Control: no-store; returning null from authorize refuses the request.
Keep externalCustomerId stable across visits and derive it from the authenticated
user, never from a browser-supplied customer ID.
Frontend: supply the session callback
For a same-origin, cookie-authenticated backend:{ resumeOnly: true }, which the helper forwards so Rhinestone only resumes an
existing customer and never creates one or binds the account. Until the user has
set up bank transfer for this account, History shows deposits only. If your
endpoint drops options, opening History binds the account like the bank step.
Use your existing authenticated HTTP client instead if your application uses
bearer authentication or requires a CSRF header. The modal sends the returned
customer token through the proxy for bank-related requests; your project API key
stays on the server. Do not persist the customer token in browser storage.
Rhinestone chooses the account currency from the residence the user declares
during verification: EUR for residents of the SEPA area, USD elsewhere. It is
not configurable.
Some residences can’t open a bank account on every rail; see the provider’s
restricted jurisdictions.
Recovery can be forwarded; refunds cannot
These two look alike and differ in exactly one way: where the authorization comes from.POST /deposits/recover carries a signature from the deposit’s recipient, covering
which deposit and which destination. The service verifies it before moving anything,
so your API key on its own achieves nothing here — which is what makes it safe to
forward like any other route. See history and recovery.
POST /deposits/refund carries no such proof. Every route in that loop passes the
browser’s body through with your API key attached, so forwarding this one would let
anyone return any of your recoverable deposits to an address they chose. A proxy
authenticates nobody, so it cannot be the thing that decides.
Most apps need only the recover route. If some of your recipients genuinely cannot
sign, authorize a refund in your own backend with
createRefundHandler, which
checks the deposit belongs to the caller before spending the key, and call the
processor directly.
Required routes
Missing a route doesn’t degrade the flow — the request 404s and that part of the modal stops working. Two routes are load-bearing rather than partial: without/chains the modal has no chain set at all, and without /register-managed there is no deposit account to send to. Everything else costs you the feature in its row.
The analytics token route
Analytics events themselves do not pass through your proxy — the modal posts them straight to Rhinestone, which is why the ingest origin belongs in your app’s content security policy rather than in your proxy. The token is the proxy’s only analytics involvement. Serve it like every other route, on the server-held key, and mark the responseCache-Control: no-store — the token is per-session and short-lived, so a shared
cache must not hand one session’s token to another. It needs no new browser
request header, no CORS allowance and no configuration, so a proxy with a fixed
allowHeaders list needs no change.
A proxy without the route leaves sessions unattributed. Collection continues and
deposits are untouched; the modal reports
token_unavailable once and
stops asking.
CORS, origins and the version header
Mobile integrations call from our origin, not yours
On the web the modal runs inside your page, so its requests carry your own domain as theOrigin. A mobile integration does not: the native wrapper loads the modal from a page we host, and every backend call it makes comes from
https://dev.deposit.rhinestone.dev if you are pointed at a dev integration). Scheme and host only — a CORS origin never carries a port or a path.
If your proxy sets an explicit origin: [...] allow-list, add it there:
cors() reflects whatever origin asks, so a proxy left on the default — including Rhinestone’s — needs no change.
The version header
Both modals sendx-deposit-modal-version on every request. Browsers reject a request carrying a header the server didn’t allow on the preflight, so an explicit allow-list must include it:
cors() in Hono is fine — with no allowHeaders it reflects whatever the preflight asks for.
Forwarding it upstream is optional, but it lets a support request be matched to the exact build you’re running. To read the value in your own app, for a bug report:
Regional payment methods
Fiat on-ramp methods vary by country, and your proxy is the only component that can see the end user: the processor sits behind it and only ever observes your proxy’s address. See payment methods and availability for the available methods. SoGET /onramp/options?provider=swapped&kind=fiat returns the generic method set unless your proxy names the user’s region.
You do not need a GeoIP database — the processor owns the lookup. The proxy only names what it observed, which takes one of two variables:
TRUSTED_COUNTRY_HEADER— you’re behind a CDN that already resolves country, so forward its header (cf-ipcountry,x-vercel-ip-country,cloudfront-viewer-country).TRUSTED_PROXY_HOPS— nothing resolves it for you, so relay the client IP and let the processor resolve it.
TRUSTED_PROXY_CIDRS, an allowlist of the peers permitted to set forwarding headers. Without it any browser could send x-forwarded-for or cf-ipcountry and choose its own region, so Rhinestone’s proxy refuses to start when you set one without the other. See its README for the details, including why hops are counted from the right.
Every path here fails closed. A wrong setting costs you localization, not correctness: you get the generic method set rather than a region that isn’t the user’s. A hand-written proxy that relays nothing behaves exactly as it does today.
Webhooks
The widget’s lifecycle callbacks are browser UI signals and fire only while the modal is open, so a user who closes it mid-bridge leaves your app unaware the deposit completed. Anything that must happen regardless — server-side settlement such as crediting a balance or sending a receipt — belongs on a webhook handler. Configure it once withPOST /setup.