{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/legacy-api/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Legacy API","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":"legacy-api","__idx":0},"children":["Legacy API"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["This API is maintained for existing integrations only."]}," No new features are being added and new partners should not integrate against it. If you are evaluating Banxa for a new integration, use the Banxa Hosted Checkout or Banxa Native API — both available from the documentation home."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"still-using-the-legacy-api","__idx":1},"children":["Still using the Legacy API?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Legacy API provides hosted checkout infrastructure for on-ramp and off-ramp transactions. Partners redirect customers to the Banxa-hosted checkout, which handles KYC, payment processing, and crypto delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"API Host"},"children":["API Host"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Sandbox"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa-sandbox.com/{partnerRef}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.banxa.com/{partnerRef}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key pages:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/legacy-api/openapi"},"children":["API Reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/legacy-api/docs/on-ramp-off-ramp/on-ramp-api-tutorial/step-3-authentication"},"children":["Authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/legacy-api/docs/on-ramp-off-ramp/webhooks"},"children":["Webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/legacy-api/docs/resources/order-status"},"children":["Order Status"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migrating","__idx":2},"children":["Migrating?"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are looking to move off the Legacy API, see the Banxa Developer Documentation for a comparison of the Banxa Hosted Checkout and Banxa Native API."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Banxa Hosted Checkout"]}," — the direct successor to the Legacy API. Same hosted checkout model, updated API design, three integration paths (Referral, API, SDK)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Banxa Native API"]}," — for platforms that want a fully headless integration with no Banxa-branded screens."]}]}]},"headings":[{"value":"Legacy API","id":"legacy-api","depth":1},{"value":"Still using the Legacy API?","id":"still-using-the-legacy-api","depth":2},{"value":"Migrating?","id":"migrating","depth":2}],"frontmatter":{"title":"Legacy API","description":"Documentation for the Banxa Legacy API. Maintained for existing integrations only. New partners should use the Banxa Hosted Checkout or Banxa Native API.","seo":{"title":"Legacy API"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/legacy-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}