{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/hosted-checkout/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"React Native SDK Reference","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":"react-native-sdk-reference","__idx":0},"children":["React Native SDK Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Banxa React Native SDK is a TypeScript-first interface to Banxa Hosted Checkout, designed for React Native mobile apps. It wraps the API in typed methods and provides a built-in WebView component for checkout presentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the end-to-end integration walkthrough, see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/sdk-integration/integration-guide"},"children":["SDK Integration Guide"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"installation","__idx":1},"children":["Installation"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"npm install @banxa-official/react-native-sdk react-native-webview\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["react-native-webview"]}," is a peer dependency. For iOS, run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pod install"]}," after installing."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"creating-a-banxa-client","__idx":2},"children":["Creating a Banxa client"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { Banxa } from '@banxa-official/react-native-sdk';\n\nconst banxa = new Banxa({\n  apiKey: 'YOUR_API_KEY',\n  partner: 'your-partner-id',\n  environment: 'sandbox', // or 'production'\n});\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configuration-options","__idx":3},"children":["Configuration options"]},{"$$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":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your Banxa API key from the Partner Dashboard."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your partner identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["environment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'sandbox'"]}," | ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'production'"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'production'"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom base URL — overrides the environment-derived URL."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"buy","__idx":4},"children":["Buy"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.buy"]}," module handles buy orders (fiat → crypto)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"createorder","__idx":5},"children":["createOrder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new buy order."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const order = await banxa.buy.createOrder({\n  externalCustomerId: 'user-123',\n  fiat: 'USD',\n  crypto: 'BTC',\n  fiatAmount: '100',\n  paymentMethodId: '1',\n  walletAddress: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',\n  redirectUrl: 'https://yourapp.com/success',\n});\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Maps to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /{partnerRef}/v2/buy"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getorder","__idx":6},"children":["getOrder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a single buy order by its Banxa order ID."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const orderDetails = await banxa.buy.getOrder(order.id);\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Maps to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/orders/{orderId}"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getordersbyaccount","__idx":7},"children":["getOrdersByAccount"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve buy orders associated with a specific ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalCustomerId"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const userBuyOrders = await banxa.buy.getOrdersByAccount('user-123');\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For retrieving a full list of all orders across all customers (reconciliation, reporting), use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":["Banxa API"]}," directly. The SDK only supports retrieval filtered by customer."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"initializecheckoutwebview","__idx":8},"children":["initializeCheckoutWebView"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure the props for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CheckoutWebView"]}," component."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const webViewProps = banxa.buy.initializeCheckoutWebView(order, {\n  onClose: () => { /* user closed checkout */ },\n  onSuccess: (url) => { /* checkout completed */ },\n  onFailure: (url) => { /* checkout failed */ },\n  returnUrlOnSuccess: 'https://yourapp.com/success',\n  returnUrlOnFailure: 'https://yourapp.com/failure',\n});\n\n// In your component render:\n{showCheckout && <CheckoutWebView {...webViewProps} />}\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The WebView detects navigation to your return URLs automatically and triggers the appropriate callback."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prices","__idx":9},"children":["Prices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.prices"]}," module retrieves live quotes. Either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fiatAmount"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cryptoAmount"]}," must be provided; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paymentMethodId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["blockchain"]}," are also required."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getquote","__idx":10},"children":["getQuote"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve a quote for a specific order type (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'buy'"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'sell'"]},")."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const quote = await banxa.prices.getQuote('buy', {\n  fiat: 'USD',\n  crypto: 'BTC',\n  fiatAmount: '100',\n  paymentMethodId: '1',\n  blockchain: 'bitcoin',\n});\n\nconsole.log('Crypto amount:', quote.cryptoAmount);\nconsole.log('Fiat amount:', quote.fiatAmount);\nconsole.log('Processing fee:', quote.processingFee);\nconsole.log('Network fee:', quote.networkFee);\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"getbuyquote","__idx":11},"children":["getBuyQuote"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Convenience method for buy quotes."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const buyQuote = await banxa.prices.getBuyQuote({\n  fiat: 'USD',\n  crypto: 'BTC',\n  fiatAmount: '100',\n  paymentMethodId: '1',\n  blockchain: 'bitcoin',\n});\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"payment-methods","__idx":12},"children":["Payment Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.paymentMethods"]}," module retrieves supported payment methods."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"// All payment methods\nconst paymentMethods = await banxa.paymentMethods.getPaymentMethods();\n\n// Filtered by currency pair\nconst methods = await banxa.paymentMethods.getPaymentMethods('USD', 'BTC');\n\n// Single payment method by ID\nconst method = await banxa.paymentMethods.getPaymentMethod(1);\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"currencies","__idx":13},"children":["Currencies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.currencies"]}," module retrieves supported fiat and crypto currencies. Fiat and crypto come from separate endpoints — availability can differ between buy and sell flows."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"// Defaults to order type 'buy'\nconst fiatCurrencies = await banxa.currencies.getFiatCurrencies();\nconst cryptoCurrencies = await banxa.currencies.getCryptoCurrencies();\n\n// Explicit order type — use 'sell' for sell flows\nconst sellFiats = await banxa.currencies.getFiats('sell');\nconst sellCrypto = await banxa.currencies.getCrypto('sell');\n\n// No single-currency endpoint — look up from the list\nconst btc = cryptoCurrencies.find((c) => c.id === 'BTC');\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"countries","__idx":14},"children":["Countries"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.countries"]}," module retrieves supported countries."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"const countries = await banxa.countries.getCountries();\nconst country = await banxa.countries.getCountry('US');\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"checkoutwebview-component","__idx":15},"children":["CheckoutWebView component"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CheckoutWebView"]}," React component renders the Banxa checkout inside your app."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { CheckoutWebView } from '@banxa-official/react-native-sdk';\n\n<CheckoutWebView {...webViewProps} />\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["banxa.buy.initializeCheckoutWebView(order, options)"]}," to generate the props. The component:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Loads the checkout URL in a WebView."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Detects navigation to your return URLs and triggers the appropriate callback."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handles camera permissions for KYC document capture (requires platform-specific setup)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some payment methods — iDEAL, Klarna, and PayPal — cannot complete inside a WebView and require the customer to be redirected outside the app. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/reference/supported-payment-methods"},"children":["Supported Payment Methods"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For iOS KYC liveness checks, you may need to use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SFSafariViewController"]}," instead of the standard WebView. → See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/checkout-experience/iframe/webview-mobile"},"children":["Embedded Checkout — Mobile"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":16},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK throws ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BanxaSDKError"]}," objects for API and network failures."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { Banxa, BanxaSDKError } from '@banxa-official/react-native-sdk';\n\ntry {\n  const order = await banxa.buy.createOrder({ /* ... */ });\n} catch (error) {\n  if (error instanceof BanxaSDKError) {\n    console.error('Banxa API Error:', error.message);\n    console.error('Error Code:', error.code);\n    console.error('Status Code:', error.statusCode);\n  } else {\n    console.error('Unknown error:', error);\n  }\n}\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"banxasdkerror-properties","__idx":17},"children":["BanxaSDKError properties"]},{"$$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":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable error description."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Banxa error code for programmatic handling."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP status code from the API response."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show user-facing messages only from validated error fields. Do not expose raw error strings that may include internal detail."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"typescript-support","__idx":18},"children":["TypeScript support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK is written in TypeScript and ships with type definitions."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import { Banxa, Order, Quote, PaymentMethod } from '@banxa-official/react-native-sdk';\n\nconst banxa = new Banxa({ /* ... */ });\n\nconst order: Order = await banxa.buy.createOrder({ /* ... */ });\nconst quote: Quote = await banxa.prices.getBuyQuote({ /* ... */ });\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"react-native-compatibility","__idx":19},"children":["React Native compatibility"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Uses the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fetch"]}," API (available in React Native)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["react-native-webview"]}," is a required peer dependency."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For iOS: run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cd ios && pod install"]}," after installing."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"native-payment-sheet-primer","__idx":20},"children":["Native payment sheet (Primer)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The SDK also supports a native payment sheet via Primer for card, Apple Pay, and Google Pay payments. This is an advanced integration for partners who verify their own users and run their own KYC — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://banxa-enterprise.redocly.app/enterprise-api/v0-beta"},"children":["Banxa Native"]},". Talk to Banxa if you'd like to discuss whether this is relevant for your integration."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"not-available-in-the-sdk","__idx":21},"children":["Not available in the SDK"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the following capabilities, use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":["Banxa API"]}," directly:"]},{"$$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":{"data-label":"Capability"},"children":["Capability"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Reason"},"children":["Reason"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Alternative"},"children":["Alternative"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["KYC data sharing (Sumsub token share)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requires HMAC authentication, which the SDK does not support"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/identity-compliance/kyc-sharing"},"children":["KYC Sharing"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full order list (all orders across all customers)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not exposed in the SDK"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /{partnerRef}/v2/orders"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":22},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/sdk-integration/integration-guide"},"children":["SDK Integration Guide"]}," — end-to-end walkthrough."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/hosted-checkout/docs/api-integration/api-integration-overview"},"children":["Banxa API Reference"]}," — for capabilities not in the SDK."]}]}]},"headings":[{"value":"React Native SDK Reference","id":"react-native-sdk-reference","depth":1},{"value":"Installation","id":"installation","depth":2},{"value":"Creating a Banxa client","id":"creating-a-banxa-client","depth":2},{"value":"Configuration options","id":"configuration-options","depth":3},{"value":"Buy","id":"buy","depth":2},{"value":"createOrder","id":"createorder","depth":3},{"value":"getOrder","id":"getorder","depth":3},{"value":"getOrdersByAccount","id":"getordersbyaccount","depth":3},{"value":"initializeCheckoutWebView","id":"initializecheckoutwebview","depth":3},{"value":"Prices","id":"prices","depth":2},{"value":"getQuote","id":"getquote","depth":3},{"value":"getBuyQuote","id":"getbuyquote","depth":3},{"value":"Payment Methods","id":"payment-methods","depth":2},{"value":"Currencies","id":"currencies","depth":2},{"value":"Countries","id":"countries","depth":2},{"value":"CheckoutWebView component","id":"checkoutwebview-component","depth":2},{"value":"Error handling","id":"error-handling","depth":2},{"value":"BanxaSDKError properties","id":"banxasdkerror-properties","depth":3},{"value":"TypeScript support","id":"typescript-support","depth":2},{"value":"React Native compatibility","id":"react-native-compatibility","depth":2},{"value":"Native payment sheet (Primer)","id":"native-payment-sheet-primer","depth":2},{"value":"Not available in the SDK","id":"not-available-in-the-sdk","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"React Native SDK Reference | Banxa Docs","description":"Complete reference for the Banxa React Native SDK: configuration, buy orders, quotes, payment methods, currencies, countries, and errors.","seo":{"title":"React Native SDK Reference"}},"lastModified":"2026-05-19T23:30:38.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/hosted-checkout/docs/sdk-integration/sdk-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}