Appearance
Deeplinks (available soon)
Overview
Deeplinks allow your MiniApp to interact with MiniPay's native features. This integration enables a smoother user experience by eliminating the need for users to manually navigate through MiniPay's interface.
Deeplinks can also be used from outside MiniPay to redirect users to your approved MiniApp or to some of MiniPay's features.
All deep links use the host link.minipay.xyz and can be triggered by other apps (e.g., WhatsApp, Slack, URL on a webpage), as well from inside the MiniPay app.
Available Deeplinks
Add Cash
Launches a new add cash flow for the selected tokens. Tokens are represented by their currency codes (in uppercase), e.g. "USDM" or "USDT". If a token is not supported by the client it's skipped.
https://link.minipay.xyz/add_cash[?tokens=XXX,YYY,ZZZ]Examples:
https://link.minipay.xyz/add_cashhttps://link.minipay.xyz/add_cash?tokens=USDMhttps://link.minipay.xyz/add_cash?tokens=USDM,USDT,USDC
Supported Tokens
The following tokens are supported in the Add Cash screen:
USDm- Mento DollarUSDT- TetherUSDC- USD Coin
Open MiniApp
Opens a MiniApp inside MiniPay by its ID. The ID is the UUID of the MiniApp's Discover listing.
https://link.minipay.xyz/miniapp?id=xxxMiniPay reads the name, icon, publisher and support link from the Discover listing, so the MiniApp opens with the same experience as when a user taps it in Discover. This is also the deeplink to use for cross-promotion — a MiniApp can open another MiniApp with it from inside its own web view.
If the ID is unknown or the MiniApp has been removed, the user is left on the Discover tab.
Open MiniApp via URL (legacy)
Deprecated for MiniApps
Use /miniapp?id=xxx above instead.
/browse?url=xxx opens a web view for any URL, but the URL's domain must be on MiniPay's browse whitelist. That whitelist is no longer maintained for MiniApp domains — new or changed MiniApp domains will not be added to it, so links using this form will stop resolving for them. It also carries no MiniApp metadata, so the destination opens as a plain web page with no icon, title or support link.
https://link.minipay.xyz/browse?url=xxxMiniApp tab
Opens MiniApps tab.
https://link.minipay.xyz/discoverTransaction Receipt
Opens a transaction receipt screen for the given transaction hash (via "tx" parameter).
https://link.minipay.xyz/receipt?tx=xxx[&celebrate]QR Code Screen
Opens user's QR code screen.
https://link.minipay.xyz/qrInvite Friends
Opens Invite Friends screen.
https://link.minipay.xyz/invite_friendsPockets Screen
Opens Pockets screen.
https://link.minipay.xyz/balanceLimitations
- The user must have MiniPay installed and be logged in. The user will be invited to install MiniPay if MiniPay is not installed.