# TagadaPay Documentation

- [TagadaPay Developer Documentation](https://docs.tagada.io/index.md): SDKs, APIs, CLIs, and integration guides for building on TagadaPay
- [Developer Tools Overview](https://docs.tagada.io/developer-tools/index.md): Everything developers need to integrate, build, and deploy with TagadaPay
- [SDKs at a glance](https://docs.tagada.io/developer-tools/sdks-at-a-glance.md): Every TagadaPay SDK explained in one page: who it’s for, what it does, and what to use instead if it’s not the right fit.
- [Choose how you accept payments](https://docs.tagada.io/developer-tools/payments/choose-your-integration.md): Four ways to accept a payment with TagadaPay. This page picks the right one in under a minute.
- [Payment method support matrix](https://docs.tagada.io/developer-tools/payments/support-matrix.md): Every card, wallet and alternative payment method TagadaPay can charge, and which processor each one runs on.
- [Processors](https://docs.tagada.io/developer-tools/payments/processors.md): Every processor TagadaPay can charge through, and which operations each one supports.
- [Alternative payment methods](https://docs.tagada.io/developer-tools/payments/alternative-payment-methods.md): Klarna, iDEAL, PayPal, BLIK and the rest — which processor charges them, and how the redirect lifecycle works.
- [Apple Pay & Google Pay](https://docs.tagada.io/developer-tools/payments/wallets.md): Which processors accept wallets, the two integration paths, and what you must configure before the sheet will open.
- [Using payment methods from the SDKs](https://docs.tagada.io/developer-tools/payments/sdk-usage.md): Which package to reach for, and the exact call that charges a card, a wallet or an APM.
- [Accept a payment with your own cart](https://docs.tagada.io/developer-tools/payments/core-js-payments.md): Tokenize a card in the browser with @tagadapay/core-js, then charge it from your server. Use this when you already have the order.
- [Trigger a Checkout from Your Website](https://docs.tagada.io/developer-tools/web-integration/trigger-checkout-from-website.md): Redirect customers from any website to your TagadaPay checkout with a simple JavaScript call
- [External Page Tracker](https://docs.tagada.io/developer-tools/web-integration/external-page-tracker.md): Track users on external pages (WordPress, WooCommerce, custom landing pages) that are part of a TagadaPay funnel
- [Tracking & Attribution](https://docs.tagada.io/developer-tools/tracking/overview.md): Pick the right ad attribution tool for your store and understand how each integrates with TagadaPay
- [ClickFlare](https://docs.tagada.io/developer-tools/tracking/clickflare.md): Server-side conversion postback for ClickFlare, fired automatically on every paid order
- [Voluum](https://docs.tagada.io/developer-tools/tracking/voluum.md): Server-side conversion postback for Voluum, fired automatically on every paid order
- [Binom](https://docs.tagada.io/developer-tools/tracking/binom.md): Server-side conversion postback for Binom (self-hosted tracker), fired automatically on every paid order
- [RedTrack](https://docs.tagada.io/developer-tools/tracking/redtrack.md): Server-side conversion postback for RedTrack with first-party cookie support
- [ClickMagick](https://docs.tagada.io/developer-tools/tracking/clickmagick.md): Server-side conversion postback for ClickMagick — link tracking and conversion attribution
- [Hyros](https://docs.tagada.io/developer-tools/tracking/hyros.md): PII-based ad attribution for Hyros — survives iOS ITP, adblockers, and cross-device flows
- [Wetracked](https://docs.tagada.io/developer-tools/tracking/wetracked.md): Shopify-only client-side attribution pixel — no API key, no configuration
- [Get an API key from code](https://docs.tagada.io/developer-tools/node-sdk/get-api-key.md): Mint a Tagada API key in 30 seconds — from a script, an AI tool, or your terminal. No dashboard, no browser.
- [Node SDK Quick Start](https://docs.tagada.io/developer-tools/node-sdk/quick-start.md): Create stores, deploy pages, and process payments from your server in 5 minutes
- [Merchant Quick Start](https://docs.tagada.io/developer-tools/node-sdk/merchant-quickstart.md): Go from zero to a live checkout in 7 Node.js SDK calls
- [Apply for TagadaPay Processing](https://docs.tagada.io/developer-tools/node-sdk/processing-applications.md): Submit a processing application — direct merchants use processing.applications.create(); CRM-only partners use partners.processing.applications.create({ accountId, … }) with the same payload.
- [Checkout Sessions](https://docs.tagada.io/developer-tools/node-sdk/checkout-sessions.md): Create pre-loaded cart links and manage checkout flows
- [Customer Management](https://docs.tagada.io/developer-tools/node-sdk/customers.md): Create, list, and manage customers with tags for funnel routing
- [Block Rules & Fraud Prevention](https://docs.tagada.io/developer-tools/node-sdk/block-rules.md): Block fraudulent transactions by IP, email, card BIN, and more
- [Processor Credentials](https://docs.tagada.io/developer-tools/node-sdk/processor-credentials.md): Required credentials and options for each payment gateway
- [Sandbox Testing](https://docs.tagada.io/developer-tools/node-sdk/sandbox-testing.md): Test payments end-to-end without real money using the sandbox processor
- [Funnel Pages](https://docs.tagada.io/developer-tools/node-sdk/custom-checkout.md): Page types, capabilities, and three ways to create them: native, custom HTML, or Plugin SDK
- [Promotions & Discount Codes](https://docs.tagada.io/developer-tools/node-sdk/promotions.md): Create percentage and fixed-amount discounts, coupon codes, and conditional promotions
- [Upsell & Downsell Funnel](https://docs.tagada.io/developer-tools/node-sdk/upsell-downsell-funnel.md): Build a checkout flow with conditional offer routing — upsell on accept, downsell on decline
- [Order Bumps](https://docs.tagada.io/developer-tools/node-sdk/order-bumps.md): Add pre-payment offers on the checkout page to increase average order value
- [Multi-PSP Routing & Vault](https://docs.tagada.io/developer-tools/node-sdk/multi-stripe-routing.md): Connect Stripe, NMI, Checkout.com, Airwallex — vault cards once, route and cascade transactions automatically
- [Subscriptions & Rebilling](https://docs.tagada.io/developer-tools/node-sdk/subscriptions.md): Create subscriptions, handle trials, manual rebills, processor changes, and the full subscription lifecycle
- [Webhooks & Events](https://docs.tagada.io/developer-tools/node-sdk/webhooks-events.md): Receive real-time notifications and monitor platform events
- [Scripts & Pixels per Step](https://docs.tagada.io/developer-tools/node-sdk/step-config-guide.md): Inject tracking pixels, custom scripts, and payment config into individual funnel steps
- [External Steps](https://docs.tagada.io/developer-tools/node-sdk/external-steps.md): Put a page you host on the funnel — declare it, then report what happens on it from your server, from the browser, or with curl
- [Funnel Canvas](https://docs.tagada.io/developer-tools/funnels/canvas.md): One picture of a store — entries, pages, wires, satellites — and the five commands that change it
- [Funnel Orchestrator](https://docs.tagada.io/developer-tools/funnels/funnel-orchestrator.md): Create multi-step checkout funnels with the API — define steps, connect pages, and track conversions
- [Funnel Lifecycle: Save, Publish & Go-Live](https://docs.tagada.io/developer-tools/funnels/funnel-lifecycle.md): Duplicate a funnel, mount it on staging, preview it, and promote it to a production domain — entirely via the API
- [Funnel demos](https://docs.tagada.io/developer-tools/funnel-demos/introduction.md): Reference funnels by type — basic post-purchase, geo-based, VIP tags, cart value. Each one ships a clonable example.
- [Basic post-purchase](https://docs.tagada.io/developer-tools/funnel-demos/basic-post-purchase.md): The simplest funnel type: landing, checkout, one-click upsell, downsell, a second offer, then thank you with related orders
- [Geo-based offers](https://docs.tagada.io/developer-tools/funnel-demos/geo-offers.md): One checkout, three localized one-click offers — route the post-purchase offer by visitor country with customer.fromCountry and customer.fromEU
- [VIP tag offers](https://docs.tagada.io/developer-tools/funnel-demos/vip-tag-offers.md): Segment the post-purchase offer with CRM customer tags — VIPs get an exclusive, everyone else gets a welcome price, via customer.hasTag
- [Cart-value upsell](https://docs.tagada.io/developer-tools/funnel-demos/cart-value-upsell.md): Let the order total pick the post-purchase offer — premium upsell for big carts, an easy add-on for small ones, via mainOrder.totalGreaterThan
- [Examples](https://docs.tagada.io/developer-tools/examples/introduction.md): Every open-source example in TagadaPay/examples, mapped to the tutorial that explains it — clone one, run tagada-init, ship
- [Checkout in plain HTML](https://docs.tagada.io/developer-tools/examples/headless-vanilla.md): A complete funnel — cart, checkout, 3DS, one-click upsells — in three HTML files. No React, no bundler, no build step.
- [Card tokenization & 3DS](https://docs.tagada.io/developer-tools/examples/card-tokenization.md): Tokenize a card in the browser with @tagadapay/core-js, create a payment instrument on your server, handle the 3DS challenge, charge
- [Wallet tokenization example](https://docs.tagada.io/developer-tools/examples/apple-google-pay.md): Native wallet buttons with @tagadapay/core-js — wallet token in, TagadaToken out, then the exact same charge path as a card
- [Shopify Checkout Script](https://docs.tagada.io/developer-tools/shopify/checkout-script.md): Install, inspect, switch, and remove the Tagada checkout script on a connected Shopify store — via the API or the Node SDK
- [WooCommerce checkout plugins](https://docs.tagada.io/developer-tools/woocommerce/checkout-plugins.md): Three official WordPress plugins, three payment flows. Pick one. Never install two.
- [SaaS Billing with TagadaPay](https://docs.tagada.io/developer-tools/saas-billing/introduction.md): Bill subscriptions from your own app — processor-agnostic, powered by payment flows
- [SaaS Billing Quick Start](https://docs.tagada.io/developer-tools/saas-billing/quick-start.md): Subscribe a customer in 15 minutes — core-js frontend + node-sdk backend
- [Payment Flows for SaaS](https://docs.tagada.io/developer-tools/saas-billing/payment-flows.md): Route charges across multiple TPAs and processors — one vault, automatic failover
- [Migrate from Stripe Billing](https://docs.tagada.io/developer-tools/saas-billing/migrate-from-stripe.md): Map Stripe objects to TagadaPay and cut over without re-collecting cards
- [Headless SDK](https://docs.tagada.io/developer-tools/headless-sdk/introduction.md): Use TagadaPay as a headless checkout and CRM backend from any website
- [Build a Store with AI + TagadaPay](https://docs.tagada.io/developer-tools/headless-sdk/build-store-with-ai.md): Use Claude, Lovable, or v0 to generate your storefront — TagadaPay handles payments, emails, and pixel tracking
- [Payment Setup](https://docs.tagada.io/developer-tools/headless-sdk/payment-setup.md): Discover available payment methods, express checkout, and process payments
- [Checkout Flow](https://docs.tagada.io/developer-tools/headless-sdk/checkout-flow.md): Manage checkout sessions, cart, promo codes, and shipping
- [Funnel Navigation](https://docs.tagada.io/developer-tools/headless-sdk/funnel-navigation.md): Send shoppers into a TagadaPay funnel from your own cart
- [Emails](https://docs.tagada.io/developer-tools/headless-sdk/emails.md): Customize transactional emails — order confirmations, subscription receipts, abandoned cart recovery, and more
- [Pixels](https://docs.tagada.io/developer-tools/headless-sdk/pixels.md): Client-side pixel tracking for Meta, TikTok, GA4, GTM, and more
- [Upsells & Offers](https://docs.tagada.io/developer-tools/headless-sdk/offers.md): Post-purchase offers, order bumps, and one-click upsells
- [Catalog](https://docs.tagada.io/developer-tools/headless-sdk/catalog.md): Browse products, variants, and prices from your store
- [Customer](https://docs.tagada.io/developer-tools/headless-sdk/customer.md): Customer profiles, order history, and subscription management
- [Plugin SDK](https://docs.tagada.io/developer-tools/sdk/introduction.md): Build powerful e-commerce plugins with React, TypeScript, or Vanilla JavaScript
- [Quick Start Guide](https://docs.tagada.io/developer-tools/sdk/quick-start.md): Build and deploy your first TagadaPay plugin in 15 minutes
- [Open-Source Plugin Examples](https://docs.tagada.io/developer-tools/sdk/open-source-examples.md): Five production-ready checkout plugins — fork, study, or ship as-is. 100% MIT.
- [Initialize Checkout with Items](https://docs.tagada.io/developer-tools/sdk/init-checkout-example.md): How to programmatically create a checkout session with line items
- [Build Your First Funnel](https://docs.tagada.io/developer-tools/sdk/tutorial.md): Create a complete checkout funnel in 20 minutes - step by step
- [Plugin Manifest](https://docs.tagada.io/developer-tools/sdk/manifest.md): Understanding plugin.manifest.json and its role in funnel orchestration
- [Funnel Resources System](https://docs.tagada.io/developer-tools/sdk/funnel-resources.md): Pass data between funnel steps with the Resource System v2.0
- [SDK API Reference (React)](https://docs.tagada.io/developer-tools/sdk/api.md): Complete API documentation for TagadaPay Plugin SDK v2
- [Plugin Examples](https://docs.tagada.io/developer-tools/sdk/examples.md): Real-world funnel plugin examples
- [SDK Best Practices](https://docs.tagada.io/developer-tools/sdk/best-practices.md): Best practices for building high-performance plugins with the TagadaPay SDK
- [Vanilla JavaScript Guide](https://docs.tagada.io/developer-tools/sdk/standalone-guide.md): Use TagadaPay SDK without any framework
- [Path Remapping (React)](https://docs.tagada.io/developer-tools/sdk/path-remapping.md): Advanced URL customization with parameter extraction for SEO and UX optimization
- [Plugin CLI](https://docs.tagada.io/developer-tools/cli/introduction.md): Deploy and manage plugins with the TagadaPay CLI
- [CLI Quick Start](https://docs.tagada.io/developer-tools/cli/quick-start.md): Get up and running with the TagadaPay CLI in minutes
- [CLI Configuration](https://docs.tagada.io/developer-tools/cli/configuration.md): Plugin manifest, config variants, and environment setup
- [Studio MCP Server](https://docs.tagada.io/developer-tools/studio-mcp/introduction.md): Let AI agents edit your Tagada Studio templates in real-time
- [Quick Start](https://docs.tagada.io/developer-tools/studio-mcp/quick-start.md): Connect an AI agent to your live Studio editor in under 2 minutes
- [Tools Reference](https://docs.tagada.io/developer-tools/studio-mcp/tools-reference.md): Complete reference for all Studio MCP tools
- [Examples](https://docs.tagada.io/developer-tools/studio-mcp/examples.md): Real prompts and workflows for AI agents editing Studio templates live
- [Get Started](https://docs.tagada.io/developer-tools/crm-mcp/introduction.md): Connect an AI assistant to your Tagada account and find out why a store is not taking payments.
- [Prompt Library](https://docs.tagada.io/developer-tools/crm-mcp/examples.md): Three ready-to-use prompts for the Tagada Config MCP.
- [Tools Reference](https://docs.tagada.io/developer-tools/crm-mcp/tools-reference.md): The nine tools on the Tagada Config MCP, what each one reports, and the one that writes.
- [Host & A/B Test Any Page](https://docs.tagada.io/developer-tools/hosting/deploy-and-ab-test.md): Deploy any HTML page or SPA onto TagadaPay and run geo or weighted A/B tests — no SDK required
- [Chargeback Provider Integration](https://docs.tagada.io/internal/chargeback-provider-integration.md): Complete guide for chargeback providers to integrate with TagadaPay API for automatic refunds
- [Internal Developer Knowledge](https://docs.tagada.io/internal/developer-knowledge.md): Critical deprecated APIs, must-know architecture patterns, and active migration paths for the Tagada codebase
- [Tagada Rx — Overview](https://docs.tagada.io/developer-tools/rx/introduction.md): The telehealth layer of the Tagada OS: intake, clinician review, e-prescribing, pharmacy fulfillment, and ship-day rebilling — orchestrated on top of your Tagada store.
- [How it works](https://docs.tagada.io/developer-tools/rx/how-it-works.md): Architecture, PHI handling, clinical webhooks, and the ship-day rebill engine — the Tagada Rx mental model.
- [Operating modes](https://docs.tagada.io/developer-tools/rx/operating-modes.md): Merchant of Record (affiliate) vs Direct Merchant — who sells, who processes, who owns compliance, and how commissions flow.
- [Building blocks](https://docs.tagada.io/developer-tools/rx/building-blocks.md): The decoupled Rx architecture: every storefront — Tagada-hosted template, headless site, or partner infrastructure — is a facade over the same small set of Rx bricks.
- [Activate in the CRM](https://docs.tagada.io/developer-tools/rx/crm-activation.md): Apply for TagadaRx, unlock the store, and map your products — from the Tagada dashboard or the API.
- [End-to-end tutorial](https://docs.tagada.io/developer-tools/rx/tutorial.md): From an activated store to a first prescription and its first refill — the complete Tagada Rx flow in seven steps.
- [Storefront templates](https://docs.tagada.io/developer-tools/rx/storefront-templates.md): The Tagada Rx template catalog: three funnel archetypes, one shared skeleton, live demos — and the matrix showing how each template maps onto the same Rx building blocks.
- [With the Plugin SDK](https://docs.tagada.io/developer-tools/rx/plugin-sdk.md): Build a Tagada-hosted telehealth storefront: quiz, checkout, case submission, and patient portal — deployed on Tagada infrastructure.
- [With the Headless SDK](https://docs.tagada.io/developer-tools/rx/headless-sdk.md): Add the Rx clinical flow to any external site — React, Vue, plain HTML, or AI-generated — with tagada.rx.
- [With the Node SDK](https://docs.tagada.io/developer-tools/rx/node-sdk.md): Server-side Rx operations: activation, clinical config, product mapping, case listing, and refills with tagada.rx.
- [Patient portal & messaging](https://docs.tagada.io/developer-tools/rx/patient-portal.md): OTP login, case timeline, secure patient↔care-team messaging, and photo-ID upload — the patient-facing half of Tagada Rx.
- [Patient support inbox](https://docs.tagada.io/developer-tools/rx/patient-support.md): How affiliate storefronts advertise a brand mailbox, how mail is routed through Resend, and who answers.
- [Platform partners](https://docs.tagada.io/developer-tools/rx/platform-partners.md): Running Tagada Rx for a fleet of merchants: white-label CRM, per-store activation, headless integration on your own funnel infrastructure, and partner economics.
- [API & events reference](https://docs.tagada.io/developer-tools/rx/api-reference.md): Every Tagada Rx endpoint and case event in one page — storefront, merchant, portal, and clinical webhooks.
- [API Reference](https://docs.tagada.io/api-reference/introduction.md): Complete reference for the TagadaPay REST API
- [IAM Overview](https://docs.tagada.io/api-reference/iam-overview.md): Job × Scope IAM — payment_ops, partneradmin, assignable sets, and the matrix behind every /iam/* endpoint. Clerk-session only.
- [Test authentication](https://docs.tagada.io/api-reference/auth/test-authentication.md): Test if the API key is valid and return user information
- [Create builder session token](https://docs.tagada.io/api-reference/builder/create-builder-session-token.md): Generate a short-lived JWT token for external builder authentication.
- [Validate builder session token](https://docs.tagada.io/api-reference/builder/validate-builder-session-token.md): Validate a builder session token and return its decoded payload. Useful for debugging and testing token validity.
- [Initialize checkout session](https://docs.tagada.io/api-reference/checkout/initialize-checkout-session.md): Initialize a checkout session and automatically redirect to the checkout URL. This endpoint works exactly  like the current CMS checkout-init page - you can navigate to it with query parameters and it will  automatically redirect the browser to the checkout page.
- [Pay checkout session V2](https://docs.tagada.io/api-reference/checkout/pay-checkout-session-v2.md): Pay for a checkout session with enhanced control over payment initiation.
- [List payments with transactions](https://docs.tagada.io/api-reference/payments/list-payments-with-transactions.md): List and filter payments with their associated transactions. Supports pagination, sorting, and advanced filtering options.
- [Refund payment](https://docs.tagada.io/api-reference/payments/refund-payment.md): Process a full or partial refund for a payment
- [Mark payment as disputed](https://docs.tagada.io/api-reference/payments/mark-payment-as-disputed.md): Mark a payment as disputed with initial dispute information. This endpoint is used to initiate a dispute on a payment.
- [Update payment dispute status](https://docs.tagada.io/api-reference/payments/update-payment-dispute-status.md): Update the dispute status of a payment. Supports various dispute statuses including RDR (Rapid Dispute Resolution) and Alert notifications.
- [Get payment currencies](https://docs.tagada.io/api-reference/payments/get-payment-currencies.md): Get all currencies used in payments for the authenticated account
- [Get available processors](https://docs.tagada.io/api-reference/payments/get-available-processors.md): Get all enabled payment processors for the authenticated account
- [Get payment by ID](https://docs.tagada.io/api-reference/payments/get-payment-by-id.md): Retrieve detailed information about a specific payment including transactions and customer data
- [Process payment](https://docs.tagada.io/api-reference/payments/process-payment.md): Process a payment using the payment flow system with comprehensive options for different payment scenarios
- [Void payment](https://docs.tagada.io/api-reference/payments/void-payment.md): Void an authorized payment transaction. This cancels a previously authorized payment before it has been captured.
- [Continue a paused payment](https://docs.tagada.io/api-reference/payments/continue-a-paused-payment.md): Resume a payment that was paused mid-flow requiring a client-side action (e.g. Airwallex Radar device fingerprinting, 3DS authentication). Intended for API consumers using `@tagadapay/core-js`.
- [List block rules](https://docs.tagada.io/api-reference/block-rules/list-block-rules.md): Get all block rules for the authenticated account with filtering and pagination
- [Create block rule](https://docs.tagada.io/api-reference/block-rules/create-block-rule.md): Create a new block rule for fraud prevention
- [Get block rule by ID](https://docs.tagada.io/api-reference/block-rules/get-block-rule-by-id.md): Retrieve detailed information about a specific block rule
- [Update block rule](https://docs.tagada.io/api-reference/block-rules/update-block-rule.md): Update an existing block rule
- [Delete block rule](https://docs.tagada.io/api-reference/block-rules/delete-block-rule.md): Delete a block rule by ID
- [List plugins for a store](https://docs.tagada.io/api-reference/plugins/list-plugins-for-a-store.md): Get all plugins associated with a specific store
- [Get public plugins](https://docs.tagada.io/api-reference/plugins/get-public-plugins.md): Get all public plugins
- [Get plugin by ID](https://docs.tagada.io/api-reference/plugins/get-plugin-by-id.md): Retrieve a specific plugin by its ID
- [List plugin deployments](https://docs.tagada.io/api-reference/plugins/list-plugin-deployments.md): Get all deployments for plugins in a store
- [Deploy plugin version from CLI](https://docs.tagada.io/api-reference/plugins/deploy-plugin-version-from-cli.md): Deploy a new version of a plugin to the CMS from the CLI tool. Supports custom domains for direct-mode plugins. Validates that custom domain + path combinations are unique to prevent conflicts.
- [Deploy plugin from marketplace](https://docs.tagada.io/api-reference/plugins/deploy-plugin-from-marketplace.md): Deploy a plugin from the public marketplace
- [Deploy plugin from blob URL](https://docs.tagada.io/api-reference/plugins/deploy-plugin-from-blob-url.md): Deploy a plugin from a blob URL. This endpoint is used after uploading a large ZIP file to blob storage to bypass the 4.5MB serverless function limit.
- [Undeploy plugin](https://docs.tagada.io/api-reference/plugins/undeploy-plugin.md): Remove a deployed plugin and make it inactive
- [Promote plugin to custom domain](https://docs.tagada.io/api-reference/plugins/promote-plugin-to-custom-domain.md): Promote a plugin to a custom domain. This will create a new route for the plugin.
- [Promote plugin deployment to alias](https://docs.tagada.io/api-reference/plugins/promote-plugin-deployment-to-alias.md): Promote an existing plugin deployment to a new alias. This reassigns the alias without creating a new deployment.
- [Count public plugins by type](https://docs.tagada.io/api-reference/plugins/count-public-plugins-by-type.md): Get a count of public plugins grouped by type. This endpoint is completely public and requires no authentication.
- [List all plugins (V2)](https://docs.tagada.io/api-reference/plugins-v2/list-all-plugins-v2.md): List all plugins for the account with their deployments using V2 schema
- [Get available features (V2)](https://docs.tagada.io/api-reference/plugins-v2/get-available-features-v2.md): Get available features across all deployments for filtering
- [List verified domains (V2)](https://docs.tagada.io/api-reference/plugins-v2/list-verified-domains-v2.md): List all verified custom domains for the account
- [List mount points (V2)](https://docs.tagada.io/api-reference/plugins-v2/list-mount-points-v2.md): List all mount points grouped by route (hostname + basePath)
- [List instances (V2)](https://docs.tagada.io/api-reference/plugins-v2/list-instances-v2.md): List all instances for a store (including those without routes)
- [Get plugin details (V2)](https://docs.tagada.io/api-reference/plugins-v2/get-plugin-details-v2.md): Get detailed information about a specific plugin
- [Get deployment details (V2)](https://docs.tagada.io/api-reference/plugins-v2/get-deployment-details-v2.md): Get detailed information about a specific deployment with instances and routes
- [Mount plugin (V2)](https://docs.tagada.io/api-reference/plugins-v2/mount-plugin-v2.md): Mount a deployment to a target (hostname, alias, or custom domain)
- [Remove route(s) from instance (V2)](https://docs.tagada.io/api-reference/plugins-v2/remove-routes-from-instance-v2.md): Remove route(s) from an instance. If routeId is provided, removes that specific route. If routeId is not provided, removes ALL routes for the instance (complete unmount).
- [Swap instance (V2)](https://docs.tagada.io/api-reference/plugins-v2/swap-instance-v2.md): Swap an instance (atomic unmount + mount for switching)
- [Update route (V2)](https://docs.tagada.io/api-reference/plugins-v2/update-route-v2.md): Update route matcher, excluder, and priority for an existing instance
- [Instantiate plugin (V2)](https://docs.tagada.io/api-reference/plugins-v2/instantiate-plugin-v2.md): Create a new instance of a deployment with a given config (without mounting). Supports API key auth.
- [Update instance config (V2)](https://docs.tagada.io/api-reference/plugins-v2/update-instance-config-v2.md): Update instance config (live config editor)
- [Remove instance (V2)](https://docs.tagada.io/api-reference/plugins-v2/remove-instance-v2.md): Remove an instance (and its direct CDN route if it exists)
- [Fork for edit (V2)](https://docs.tagada.io/api-reference/plugins-v2/fork-for-edit-v2.md): Fork an instance for editing (optimized atomic operation)
- [Promote preview (V2)](https://docs.tagada.io/api-reference/plugins-v2/promote-preview-v2.md): Promote a preview instance to production (commit)
- [Delete plugin (V2)](https://docs.tagada.io/api-reference/plugins-v2/delete-plugin-v2.md): Delete a plugin and all its deployments
- [Delete deployment (V2)](https://docs.tagada.io/api-reference/plugins-v2/delete-deployment-v2.md): Delete a specific deployment
- [Set deployment visibility (V2)](https://docs.tagada.io/api-reference/plugins-v2/set-deployment-visibility-v2.md): Set deployment visibility (public/private)
- [Deploy plugin from URL (V2)](https://docs.tagada.io/api-reference/plugins-v2/deploy-plugin-from-url-v2.md): Deploy plugin from URL (CRM feature - uses V2 schema).          ⚠️ **OVERWRITE MODE**: Set 'overwrite: true' to replace assets for an existing deployment with the same version.
- [Sync deployment config (V2)](https://docs.tagada.io/api-reference/plugins-v2/sync-deployment-config-v2.md): Sync config presets, schema, and uiSchema to an existing deployment without redeploying
- [Validate plugin manifest (V2)](https://docs.tagada.io/api-reference/plugins-v2/validate-plugin-manifest-v2.md): Validate a plugin manifest without deploying.
- [Deploy plugin with inline assets (V2)](https://docs.tagada.io/api-reference/plugins-v2/deploy-plugin-with-inline-assets-v2.md): Deploy a plugin with base64-encoded inline assets.
- [Configure split testing (V2)](https://docs.tagada.io/api-reference/plugins-v2/configure-split-testing-v2.md): Configure A/B or geo-based split testing on an existing route.
- [Get deployment source data (V2)](https://docs.tagada.io/api-reference/plugins-v2/get-deployment-source-data-v2.md): Fetch the source data (e.g., FunnelTemplate) for a deployment.
- [List plugins for a store](https://docs.tagada.io/api-reference/plugins-v2/list-plugins-for-a-store.md): List all plugins for a store (GET alternative to POST /plugins/v2/list)
- [List instances for a store](https://docs.tagada.io/api-reference/plugins-v2/list-instances-for-a-store.md): List all plugin instances for a store. Optionally filter by deploymentId query param.
- [Retrieve a single instance](https://docs.tagada.io/api-reference/plugins-v2/retrieve-a-single-instance.md): Get detailed information about a specific plugin instance by ID, including its deployment data.
- [Retrieve a deployment](https://docs.tagada.io/api-reference/plugins-v2/retrieve-a-deployment.md): Get deployment details by ID. Unlike the POST endpoint, this does not require storeId — deployments are global resources.
- [List mount points for a store](https://docs.tagada.io/api-reference/plugins-v2/list-mount-points-for-a-store.md): List all mount points grouped by route (GET alternative to POST /plugins/v2/mount-points)
- [Get plugin details](https://docs.tagada.io/api-reference/plugins-v2/get-plugin-details.md): Get detailed information about a specific plugin (GET alternative to POST /plugins/v2/details)
- [List custom domains](https://docs.tagada.io/api-reference/domains/list-custom-domains.md): Get all custom domains for the authenticated account
- [Add custom domain](https://docs.tagada.io/api-reference/domains/add-custom-domain.md): Add a new custom domain to the account
- [Verify custom domain](https://docs.tagada.io/api-reference/domains/verify-custom-domain.md): Verify DNS configuration and ownership of a custom domain
- [Remove custom domain](https://docs.tagada.io/api-reference/domains/remove-custom-domain.md): Remove a custom domain and all associated routes
- [Get domain configuration](https://docs.tagada.io/api-reference/domains/get-domain-configuration.md): Get DNS configuration status and recommended CNAME for a custom domain
- [Lookup DNS records](https://docs.tagada.io/api-reference/domains/lookup-dns-records.md): Query DNS records for a domain using both standard and Google DNS resolvers
- [List orders](https://docs.tagada.io/api-reference/orders/list-orders.md): Get all orders for the authenticated account with filtering, sorting, and pagination
- [Get order by ID](https://docs.tagada.io/api-reference/orders/get-order-by-id.md): Retrieve detailed information about a specific order including line items, payments, and customer data
- [List subscriptions](https://docs.tagada.io/api-reference/subscriptions/list-subscriptions.md): Get all subscriptions for the authenticated account with filtering, sorting, and pagination
- [Get subscription by ID](https://docs.tagada.io/api-reference/subscriptions/get-subscription-by-id.md): Retrieve detailed information about a specific subscription including customer, product, and payment details
- [Rebill subscription](https://docs.tagada.io/api-reference/subscriptions/rebill-subscription.md): Immediately rebill a subscription. A subscription billed as part of a subscription group is rebilled as one charge for the whole group: the amount covers every billable member and the outcome reports that group attempt. Retry metadata count and attempts are handled internally.
- [Cancel subscriptions](https://docs.tagada.io/api-reference/subscriptions/cancel-subscriptions.md): Cancel one or more subscriptions with option to cancel immediately or at period end
- [Resume subscriptions](https://docs.tagada.io/api-reference/subscriptions/resume-subscriptions.md): Resume one or more previously canceled subscriptions
- [Change subscription processor](https://docs.tagada.io/api-reference/subscriptions/change-subscription-processor.md): Change the preferred payment processor for a subscription or remove processor preference
- [Create subscription](https://docs.tagada.io/api-reference/subscriptions/create-subscription.md): Create a new subscription for a customer with specified product and pricing
- [List products](https://docs.tagada.io/api-reference/products/list-products.md): Get all products for a specific store with filtering, sorting, and pagination
- [Create product](https://docs.tagada.io/api-reference/products/create-product.md): Create a new product with variants and prices for a specific store
- [Get product by ID](https://docs.tagada.io/api-reference/products/get-product-by-id.md): Retrieve detailed information about a specific product including variants and pricing
- [Update product](https://docs.tagada.io/api-reference/products/update-product.md): Update an existing product's fields such as name, description, active status, tax settings, and shipping configuration
- [Delete products](https://docs.tagada.io/api-reference/products/delete-products.md): Delete one or more products by their IDs
- [List app events (Admin Only)](https://docs.tagada.io/api-reference/events/list-app-events-admin-only.md): Get all app events for the authenticated account with filtering, sorting, and pagination. Events track user and system activities within the application. **Requires org:admin role.**
- [Get event by ID (Admin Only)](https://docs.tagada.io/api-reference/events/get-event-by-id-admin-only.md): Retrieve a specific app event by its ID including related customer and store information. **Requires org:admin role.**
- [Get event statistics (Admin Only)](https://docs.tagada.io/api-reference/events/get-event-statistics-admin-only.md): Get aggregated statistics about events for the authenticated account including counts by type and processing status. **Requires org:admin role.**
- [Get recent events (Admin Only)](https://docs.tagada.io/api-reference/events/get-recent-events-admin-only.md): Get the most recent events for the authenticated account with optional limit. **Requires org:admin role.**
- [Create customer](https://docs.tagada.io/api-reference/customers/create-customer.md): Create a new customer for a store
- [List customers](https://docs.tagada.io/api-reference/customers/list-customers.md): List customers with filtering, sorting and pagination
- [Get customer by ID](https://docs.tagada.io/api-reference/customers/get-customer-by-id.md): Get customer details including payment instruments and device info
- [List payment instruments](https://docs.tagada.io/api-reference/payment-instruments/list-payment-instruments.md): List payment instruments with filtering, sorting and pagination
- [Get payment instrument by ID](https://docs.tagada.io/api-reference/payment-instruments/get-payment-instrument-by-id.md): Get payment instrument details including customer info and card enrichment
- [List customer payment instruments](https://docs.tagada.io/api-reference/payment-instruments/list-customer-payment-instruments.md): Get all active payment instruments for a customer
- [Create payment instrument from TagadaToken](https://docs.tagada.io/api-reference/payment-instruments/create-payment-instrument-from-tagadatoken.md): Create a payment instrument from a base64 encoded TagadaToken. This endpoint decodes the TagadaToken  and extracts the necessary payment information to create a payment instrument.
- [Raw card data capability (SDK internal)](https://docs.tagada.io/api-reference/payment-instruments/raw-card-data-capability-sdk-internal.md): Used by `@tagadapay/node-sdk` `paymentInstruments.createFromCard()`. Returns the public, create-only vault key the SDK uses to tokenize a card **from the merchant's server directly into Tagada's PCI vault** — the card number never reaches the Tagada API. Not meant to be called by hand.
- [Create 3DS session](https://docs.tagada.io/api-reference/3ds/create-3ds-session.md): Create a 3DS (Three Domain Secure) authentication session for enhanced payment security.
- [Create 3RI (merchant-initiated) 3DS session](https://docs.tagada.io/api-reference/3ds/create-3ri-merchant-initiated-3ds-session.md): Create a server-side 3DS session for merchant-initiated (3RI) authentication. No browser or device info needed — uses just the card token. Used for recurring rebill authentication without cardholder interaction.
- [Authenticate 3DS session (standalone)](https://docs.tagada.io/api-reference/3ds/authenticate-3ds-session-standalone.md): Trigger BasisTheory 3DS authentication for a previously created session. Returns challenge/frictionless decision and all 3DS values (ECI, CAVV, transStatus, etc.).
- [Get 3DS challenge result](https://docs.tagada.io/api-reference/3ds/get-3ds-challenge-result.md): After a 3DS challenge has been completed by the cardholder, retrieve the final authentication result. Returns updated 3DS values (ECI, CAVV, transStatus, etc.).
- [Create 3DS session from external authentication values (bring your own 3DS)](https://docs.tagada.io/api-reference/3ds/create-3ds-session-from-external-authentication-values-bring-your-own-3ds.md): You already run 3-D Secure with your own MPI / 3DS server and only want Tagada to charge. Report the final authentication values (ECI, CAVV/AAV, DS transaction id, protocol version) and Tagada stores them as an already-authenticated 3DS session. Pass the returned `id` as `threedsSessionId` to `POST…
- [List stores](https://docs.tagada.io/api-reference/stores/list-stores.md): Get all stores for the authenticated account with filtering, sorting, and pagination
- [Create store](https://docs.tagada.io/api-reference/stores/create-store.md): Create a new store for the authenticated account
- [Get store by ID](https://docs.tagada.io/api-reference/stores/get-store-by-id.md): Retrieve detailed information about a specific store
- [List funnels for a store](https://docs.tagada.io/api-reference/funnels/list-funnels-for-a-store.md): Retrieve all funnels for a specific store
- [Get funnel by ID](https://docs.tagada.io/api-reference/funnels/get-funnel-by-id.md): Retrieve configuration and details for a specific funnel
- [Create a new funnel](https://docs.tagada.io/api-reference/funnels/create-a-new-funnel.md): Create a new funnel with the provided configuration
- [Update funnel with routing](https://docs.tagada.io/api-reference/funnels/update-funnel-with-routing.md): Update a funnel configuration and automatically handle plugin mount/unmount/swap operations
- [Delete a funnel](https://docs.tagada.io/api-reference/funnels/delete-a-funnel.md): Delete a funnel and clean up all associated routes
- [Promote funnel to production](https://docs.tagada.io/api-reference/funnels/promote-funnel-to-production.md): Promote the staging funnel configuration to production on the specified custom domain. Handles instance cloning, route setup, and prebuilds automatically.
- [Create a preview session](https://docs.tagada.io/api-reference/funnels/create-a-preview-session.md): Create a preview funnel session with pre-filled context for testing
- [Get funnel session data](https://docs.tagada.io/api-reference/funnel-sessions/get-funnel-session-data.md): Retrieve full funnel session data from KV storage including customer history, resources, and metadata. Useful for debugging funnel flows.
- [Track funnel step event](https://docs.tagada.io/api-reference/funnel-tracking/track-funnel-step-event.md): Track funnel step events for analytics and conversion tracking.
- [Health check](https://docs.tagada.io/api-reference/health/health-check.md): Simple health check endpoint to verify API is running
- [Execute test scenario](https://docs.tagada.io/api-reference/test/execute-test-scenario.md): Execute a test scenario to validate event system behavior.
- [Execute test scenario with simulated failure](https://docs.tagada.io/api-reference/test/execute-test-scenario-with-simulated-failure.md): Execute a test scenario that simulates handler failure to test retry logic.
- [Get registered deferred handlers](https://docs.tagada.io/api-reference/test/get-registered-deferred-handlers.md): Inspect the deferred handler registry to see which handlers are registered.
- [Get scenario result from KV](https://docs.tagada.io/api-reference/test/get-scenario-result-from-kv.md): Retrieve test scenario execution results from KV store.
- [List all test scenarios from KV](https://docs.tagada.io/api-reference/test/list-all-test-scenarios-from-kv.md): Get a list of all test scenario results stored in KV
- [Clear scenario result from KV](https://docs.tagada.io/api-reference/test/clear-scenario-result-from-kv.md): Remove a test scenario result from KV storage
- [List webhook endpoints](https://docs.tagada.io/api-reference/webhooks/list-webhook-endpoints.md): List all webhook endpoints for a store
- [Create webhook endpoint](https://docs.tagada.io/api-reference/webhooks/create-webhook-endpoint.md): Create a new webhook endpoint to receive event notifications
- [Delete webhook endpoint](https://docs.tagada.io/api-reference/webhooks/delete-webhook-endpoint.md): Delete an existing webhook endpoint
- [List webhook deliveries](https://docs.tagada.io/api-reference/webhooks/list-webhook-deliveries.md): List delivery attempts for a webhook endpoint, most recent first. Paginated and filterable by event type, delivery status, and creation date range. Delivery history is retained for 6 months.
- [List promotions](https://docs.tagada.io/api-reference/promotions/list-promotions.md): Get all promotions for a specific store with filtering, sorting, and pagination
- [Create promotion](https://docs.tagada.io/api-reference/promotions/create-promotion.md): Create a new promotion with rules and actions for a specific store
- [Update promotion](https://docs.tagada.io/api-reference/promotions/update-promotion.md): Update an existing promotion by ID. To manage redeemable codes for the promotion, use the `/promotion-codes/*` endpoints — this endpoint does not accept a `promotionCodes` array.
- [Get promotion by ID](https://docs.tagada.io/api-reference/promotions/get-promotion-by-id.md): Retrieve detailed information about a specific promotion including rules and actions
- [Delete promotions](https://docs.tagada.io/api-reference/promotions/delete-promotions.md): Delete one or more promotions by their IDs
- [List promotion codes](https://docs.tagada.io/api-reference/promotion-codes/list-promotion-codes.md): Get promotion codes with filtering and pagination
- [Create promotion code](https://docs.tagada.io/api-reference/promotion-codes/create-promotion-code.md): Create a new promotion code linked to an existing promotion
- [Update promotion code](https://docs.tagada.io/api-reference/promotion-codes/update-promotion-code.md): Update an existing promotion code by ID
- [Delete promotion codes](https://docs.tagada.io/api-reference/promotion-codes/delete-promotion-codes.md): Delete one or more promotion codes by their IDs
- [List processors](https://docs.tagada.io/api-reference/processors/list-processors.md): List all active (non-archived) processors for the authenticated account. Requires org:admin role. Returns processor config including acquirer BINs and supported currencies.
- [Get processor by ID](https://docs.tagada.io/api-reference/processors/get-processor-by-id.md): Retrieve a single processor by its ID. Returns full processor details including options and supported currencies. Requires org:admin role.
- [Create processor](https://docs.tagada.io/api-reference/processors/create-processor.md): Create a new payment processor (PSP/gateway) connection. Requires org:admin role.
- [Update processor](https://docs.tagada.io/api-reference/processors/update-processor.md): Update an existing processor configuration (name, credentials, currencies, enabled status). Requires org:admin role.
- [Delete processors](https://docs.tagada.io/api-reference/processors/delete-processors.md): Soft-delete (archive) one or more processors by their IDs. Archived processors are excluded from payment flows. Requires org:admin role.
- [Initiate Stripe Connect OAuth](https://docs.tagada.io/api-reference/processors/initiate-stripe-connect-oauth.md): Start the Stripe Connect OAuth flow for a processor. Returns a URL that the merchant must visit in their browser to authorize their Stripe account.
- [Disconnect Stripe Connect account](https://docs.tagada.io/api-reference/processors/disconnect-stripe-connect-account.md): Revoke the OAuth connection for a Stripe Connect account. This deauthorizes the connected Stripe account and disables the processor. Requires org:admin role.
- [Get Stripe Connect account details](https://docs.tagada.io/api-reference/processors/get-stripe-connect-account-details.md): Retrieve details about a connected Stripe account (capabilities, charges enabled, payouts enabled, country, etc.). Requires org:admin role.
- [List payment flows](https://docs.tagada.io/api-reference/payment-flows/list-payment-flows.md): List all active (non-archived) payment flows for the authenticated account. Requires org:admin role.
- [List payment flows with processor details](https://docs.tagada.io/api-reference/payment-flows/list-payment-flows-with-processor-details.md): List all active payment flows with full processor information (name, type, config) resolved inline. Requires org:admin role.
- [Get payment flow by ID](https://docs.tagada.io/api-reference/payment-flows/get-payment-flow-by-id.md): Retrieve a single payment flow by its ID. Requires org:admin role.
- [Get payment flow with processor details](https://docs.tagada.io/api-reference/payment-flows/get-payment-flow-with-processor-details.md): Retrieve a single payment flow with full processor information resolved inline. Requires org:admin role.
- [Create payment flow](https://docs.tagada.io/api-reference/payment-flows/create-payment-flow.md): Create a new payment flow (processor orchestration configuration). Requires org:admin role.
- [Update payment flow](https://docs.tagada.io/api-reference/payment-flows/update-payment-flow.md): Update an existing payment flow. All fields in `data` are optional except fallbackProcessorConfigs. Requires org:admin role.
- [Delete payment flow](https://docs.tagada.io/api-reference/payment-flows/delete-payment-flow.md): Soft-delete a payment flow (sets archivedAt). Also clears this flow from any stores that had it as default. Requires org:admin role.
- [List offers](https://docs.tagada.io/api-reference/offers/list-offers.md): List upsell offers and order bumps for a store. Filter by type (upsell or orderbump), enabled status, and search text.
- [Get offer by ID](https://docs.tagada.io/api-reference/offers/get-offer-by-id.md): Retrieve a single upsell offer or order bump by its ID.
- [Update offer](https://docs.tagada.io/api-reference/offers/update-offer.md): Update an existing upsell offer or order bump.
- [Create offer](https://docs.tagada.io/api-reference/offers/create-offer.md): Create a new upsell offer or order bump for a store.
- [Delete offers](https://docs.tagada.io/api-reference/offers/delete-offers.md): Delete one or more upsell offers or order bumps by their IDs.
- [Create checkout offer](https://docs.tagada.io/api-reference/checkout-offers/create-checkout-offer.md): Create a checkout offer (used by native offer pages). Unlike /offers/create which creates upsell/bump records, this creates a proper checkout offer with line items and promotions.
- [List checkout offers](https://docs.tagada.io/api-reference/checkout-offers/list-checkout-offers.md): List checkout offers for a store. Filter by search text.
- [Delete checkout offers](https://docs.tagada.io/api-reference/checkout-offers/delete-checkout-offers.md): Delete one or more checkout offers by their IDs.
- [Get checkout offer by ID](https://docs.tagada.io/api-reference/checkout-offers/get-checkout-offer-by-id.md): Retrieve a single checkout offer with its line items and promotions.
- [Create radar session](https://docs.tagada.io/api-reference/radar-sessions/create-radar-session.md): Save a device fingerprint / fraud-detection session ID generated by a provider's client-side SDK (e.g. Airwallex Radar). Intended for API consumers using `@tagadapay/core-js`.
- [List email templates](https://docs.tagada.io/api-reference/email-templates/list-email-templates.md): List all email templates for a store
- [Create email template](https://docs.tagada.io/api-reference/email-templates/create-email-template.md): Create a new email template for a store
- [Update email template](https://docs.tagada.io/api-reference/email-templates/update-email-template.md): Update an existing email template
- [Delete email template](https://docs.tagada.io/api-reference/email-templates/delete-email-template.md): Delete an email template
- [Send test email](https://docs.tagada.io/api-reference/email-templates/send-test-email.md): Send a test email using a template
- [Preview email template](https://docs.tagada.io/api-reference/email-templates/preview-email-template.md): Preview a rendered email template with mock data
- [List template types](https://docs.tagada.io/api-reference/email-templates/list-template-types.md): List all available email template types with labels and descriptions
- [Create a shipping rate](https://docs.tagada.io/api-reference/shipping/create-a-shipping-rate.md): Create a shipping rate for a store. The new rate is matched against incoming checkout sessions on country, cart subtotal, and total weight, and surfaced via `GET /checkout-sessions/:id/shipping-rates`.
- [List tax exemptions](https://docs.tagada.io/api-reference/tax-exemptions/list-tax-exemptions.md): List tax exemptions for a store with pagination.
- [Bulk create tax exemptions](https://docs.tagada.io/api-reference/tax-exemptions/bulk-create-tax-exemptions.md): Create one or more tax exemptions for a store. Customers whose email matches an exemption are excluded from tax calculations at checkout.
- [Delete tax exemptions](https://docs.tagada.io/api-reference/tax-exemptions/delete-tax-exemptions.md): Delete one or more tax exemptions by ID. Only exemptions belonging to your account will be removed.

## OpenAPI Specs

- [openapi](/openapi.json)

## Optional

- [Help Center](https://help.tagada.io)
- [Roadmap](https://feedback.tagada.io/roadmap)
- [Changelog](https://feedback.tagada.io/changelog)
- [Dashboard](https://crm.tagadapay.com)
- [Support](mailto:api-support@tagadapay.com)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.