{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Constructing Referral URLs","description":"Official Banxa API documentation – on-ramp and off-ramp transfers with identity verification and compliance.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"constructing-referral-urls","__idx":0},"children":["Constructing Referral URLs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Banxa provides you with a base referral URL for your partner account. You construct a transaction-ready URL by appending query parameters."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"url-structure","__idx":1},"children":["URL structure"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://{partnerRef}.banxa.com?{parameters}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{partnerRef}"]}," is your partner subdomain, provided by Banxa during onboarding. For sandbox, use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://{partnerRef}.banxa-sandbox.com?{parameters}\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":2},"children":["Example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A referral URL pre-populated with a wallet address, crypto asset, and fiat currency:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://yourpartner.banxa.com?walletAddress=0xe3BDEFdAeFF070925eB7FfC49F9B30c647Cb751e&coinType=ETH&fiatType=AUD&blockchain=ETH\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parameters are standard URL query string format. All parameters are optional — any value not supplied will default to the customer's previous selection or the checkout defaults configured in your Partner Dashboard."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"encoding","__idx":3},"children":["Encoding"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always URL-encode parameter values, particularly wallet addresses and email addresses which may contain special characters."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"choosing-a-checkout-mode","__idx":4},"children":["Choosing a checkout mode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have your referral URL, choose how to present it:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Redirect"]}," — open the URL in a new tab or the same window."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["iFrame / WebView"]}," — load the URL inside an embedded component in your app."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["→ See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/checkout-experience/redirect/redirect-overview"},"children":["Checkout Experience"]}," for implementation details."]}]},"headings":[{"value":"Constructing Referral URLs","id":"constructing-referral-urls","depth":1},{"value":"URL structure","id":"url-structure","depth":2},{"value":"Example","id":"example","depth":2},{"value":"Encoding","id":"encoding","depth":2},{"value":"Choosing a checkout mode","id":"choosing-a-checkout-mode","depth":2}],"frontmatter":{"title":"Constructing Banxa Referral URLs | Banxa Docs","description":"Build Banxa referral URLs by appending query parameters to your partner subdomain. Covers sandbox and production URL formats with URL encoding guidance.","seo":{"title":"Constructing Referral URLs"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/referral-integration/constructing-referral-urls","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}