> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Payments Status > See where your Fluid Payments onboarding stands, which processors, payment methods and countries are live, and your newest transactions. Use the **Payments Status** screen to follow your Fluid Payments setup. It shows which card processors (PSPs) and alternative payment methods (APMs) are live or still being set up, which countries can take payments, and your company's most recent transactions. ## Where to find it In the admin sidebar, under **Payments**, select **Accounts**. To open the screen, your role needs **View only** or **Full access** for **Payment Accounts**. On the [Roles](/help/admin/settings/roles) screen, **Payment Accounts** is in the **Commerce** card. Open the card and set access from the **Payment Accounts** area's menu. Without it, **Accounts** isn't in the sidebar, and opening the screen shows a message that you don't have permission to view the page. ## What's on the screen The page header reads **Payments Status**. ### Setup banner At the top, a banner shows where your Fluid Payments setup stands. While the onboarding form is unsubmitted and no provider is being set up, the rest of the screen is greyed out and can't be clicked. | Banner | When it appears | What you can do | | :- | :- | :- | | **Fluid Payments is not set up yet** | You haven't started the onboarding form, and no provider is being set up. | **Learn More** opens the **Set Up Payments** panel. **Activate Fluid Payments** opens the onboarding form. | | **Finish providing your onboarding information** | You started the onboarding form but haven't submitted it. | **Resume Onboarding Form** opens the form so you can finish it. | | **We've received your onboarding form** | You submitted the form, or providers are being set up, and none is live yet. | Nothing. Fluid is setting up your processors and APMs. Check this screen for updates. | | **We're still working, but Fluid Payments is live** | At least one provider is live, and others are still being set up. | Nothing. Your payment routing is live, and the remaining processors follow. | When every provider being set up is live, no banner appears. If the screen can't load your setup, a red banner shows the error, or **Failed to load payments status**. The onboarding form needs its own permission, **Payments Onboarding**, also in the **Commerce** card. Without it, the setup buttons show a message that you don't have permission to view the page. See [Onboarding](/help/admin/settings/onboarding). ### Summary tiles Four tiles sit under the banner: * **Token Vault**: **Ready** (**Tokenization live**) once card tokenization is set up. Until then it reads **In Progress** (**Setting up tokenization**). * **PSPs Connected**: live card processors out of all processors being set up. Below the count, **All processors live**, or how many are still **in setup**. * **APMs Enabled**: how many alternative payment methods are live. * **Countries Ready**: countries ready to take payments, out of all the countries in your setup. Below the count, how many are **partially live**, **Full global coverage** when all are ready, or **Countries in setup**. ### Map and countries The map colors each country in your setup by its status. Point at a country to see its status, such as **Ready** or **In Progress**. Click it to jump to its card in the **Countries** list beside the map. Scroll over the map to zoom in, and drag to move around while zoomed in. **Reset view** puts the map back. The **Countries** list shows how many countries you have, with ready countries first, then those in progress, then those not configured, each group in alphabetical order. Each country card shows: * **Status badge**: point at it to see the reason, when one is given. * **PSPs**: a logo for each card processor in that country. Point at a logo to see its name and status: **Live — accepting payments**, or its setup stage. Logos of processors that aren't live are faded. * **APMs**: the same for alternative payment methods. **Apple Pay** is listed when an active card processor that offers Apple Pay, and isn't a test or sandbox account, is live in that country. * **Services**: point at **Vault** to see whether card tokenization is **Configured** there. The 3-D Secure chip reads **3DS2 Required** or **3DS2 Not Required**; point at it to see whether 3-D Secure is **Configured**. ### Processor and APM tiles Below the map, a row of tiles shows your card processors, live ones first, then by setup stage. To see your alternative payment methods instead, click **Show APMs** on the **APMs** tile. To switch back, click **Show PSPs** on the **Credit Cards** tile, which shows how many processors you have. Each tile shows the provider's name and logo, and up to three country flags. Point at the flags to see all of its countries and their status, or **Country assignments pending**. A provider that's still being set up shows: * Its stage: **Initial Setup**, **Underwriting** or **Connecting & Testing**, with a three-step progress bar. * **Est. time until live**, or **Pending ETA** when no estimate has been set. Point at the icon next to an estimate: it's a rough estimate and subject to change. A provider marked **Not Onboarding** isn't being set up. Card processor tiles in this state are greyed out. A single live provider shows: * Its processing fee: basis points (**bps**) plus a fixed amount for card processors, a percentage plus a fixed amount for APMs. * A read-only **Enabled** switch. It's on when the provider is active and isn't a test or sandbox account. A live provider that isn't enabled is dimmed. Live card processors that use the same gateway are grouped on one tile with an **N MIDs** badge (or **x/y** when only some are enabled). Click the badge or the footer to see each account's fee and countries. The footer reads **x/y enabled** instead of a switch. A small Apple Pay badge on a processor's logo means it offers Apple Pay. A round-arrow badge on an APM's logo means it supports recurring payments. ### Recent Transactions Once at least one provider is live, **Recent Transactions** lists up to 12 of your company's most recent transactions, newest first, and checks for new ones every 5 seconds. If a checkout has more than one transaction, it gets one row, showing its latest finished transaction, or its latest one if none has finished. Its columns include: * **Time**: how long ago, such as `45s ago`, `3m ago` or `2h ago`. * **Transaction**: the first 12 characters of the transaction's ID. * **Method**: **Credit card**, or the payment method's name, such as **PayPal**. * **Provider**: the payment account that processed it. * **Status**: **Approved**, **Declined**, or **Processing** for anything else. * **Amount**: in the transaction's currency. On wider screens, the header also shows a small bar chart with one bar per row, colored by status, and the approval rate, with how many were approved and declined. These count only the rows in the table. When a new transaction comes in, a short animation carries it to the provider tiles, and then it's added to the top of the table. The animation replays a transaction that's already recorded; it doesn't show how long the payment took. Before any provider is live, the table reads **No recent transactions yet.** ## Set up Fluid Payments Clicking **Learn More** on the **Fluid Payments is not set up yet** banner opens the **Set Up Payments** panel. Under **Choose Your Payment Experience**, you can pick: * **Activate Fluid Payments**: opens the onboarding form. * **Connect to existing provider accounts**: for using your own existing gateway and payment method accounts instead of Fluid Payments. It opens the **Alternative Payment Accounts** screen in Settings. See [APM](/help/admin/settings/apm). * **Need Help?**: opens a page in a new browser tab where you can schedule a call with Fluid's payment specialists. Each choice closes the panel. On the banner, click **Activate Fluid Payments**, or **Resume Onboarding Form** if you've already started. Complete each section of the form and submit it. See [Onboarding](/help/admin/settings/onboarding). Come back to **Accounts** to follow progress. Once your form is received, the banner reads **We've received your onboarding form**. If the banner hasn't changed, reload the screen. As each provider is set up, its tile shows the current stage and, when one is set, the estimated time until live. ## Frequently asked questions The tiles, map and transactions stay greyed out while the onboarding form is unsubmitted and no provider is being set up. Click **Activate Fluid Payments** or **Resume Onboarding Form** on the banner to finish it. No time estimate has been set for that provider yet. The tile still shows its current stage. ## Related pages * [Onboarding](/help/admin/settings/onboarding) * [Transactions](/help/admin/company-payment-reports) * [Payment performance](/help/admin/payments/performance) * [Gateways](/help/admin/settings/gateways) * [APM](/help/admin/settings/apm) * [Payment Routing](/help/admin/settings/payment-routing) * [Countries](/help/admin/settings/countries) * [Roles](/help/admin/settings/roles) * [Complete payments onboarding](/setup/payments-onboarding) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.