> ## 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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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. # Payment Gateways > Add and edit the gateways that process your card payments, and set each one's countries, transaction types, test mode, and Apple Pay. **Gateways** in Settings opens the **Payment Gateways** screen. Here you manage the gateways that process your company's credit card payments; for non-card payment accounts, see [APM](/help/admin/settings/apm). ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Payments**, select **Gateways**. To open the screen, your role needs at least **View only** for **Gateways**, in the **Settings** card on the role's **Permissions** tab. To add, edit, or delete gateways, it needs **Full access** for **Gateways**. To allow only some actions, open the **Gateways** area on the role and turn on the switches you want: **Set up new payment gateways** (add), **Edit payment gateway configuration** (edit), and **Remove payment gateways** (delete). The area's button then shows **Custom**. To add or edit a gateway, your role also needs at least **View only** for **Payment Integrations** and **Business Entities**, in the **Commerce** card, and for **Company Countries**, in the **Settings** card. With **View only**, you can see the table, but **Add Payment Gateway** and the row's three-dot menu don't appear, and clicking a row doesn't open it. See [Roles](/help/admin/settings/roles). ## What's on the screen The top bar holds the **Add Payment Gateway** button. Two alerts can appear above the **Credit Card Processing** card: * **No usable test gateway** lists countries that have test mode turned on but no usable test gateway. It warns that card payments will be blocked if company test mode is on. To fix it, assign a usable test gateway in [Payment Routing](/help/admin/settings/payment-routing#test-mode), or turn off test mode for those countries. See [What does the No test gateway badge mean?](/help/admin/settings/countries#no-test-gateway) * **Test mode status unavailable** appears when the check for countries without a test gateway fails. Click **Retry** to check again. The **Credit Card Processing** card shows the supported cards: Visa, Mastercard, American Express, and Discover. Below them, the **Payment Gateways** table lists your card gateways. The tabs above the table filter it: **All**, **Active**, **Inactive**, and **Sandbox**. **All** is selected when the screen opens. The sort button (up and down arrows) opens the **Sort By** menu. Sort by **Name**, or by **Country** (how many countries a gateway has), in **Ascending** or **Descending** order. Until you choose a sort, the table shows active gateways before inactive ones, and production gateways before sandbox ones, in name order. | Column | What it shows | | - | - | | **Icon** | The Apple Pay logo if **Apple Pay Enabled** is turned on for the gateway. Other gateways show a generic Fluid Pay logo. | | **Name** | The gateway's **Display Name**. | | **Status** | **Active** or **Inactive**. | | **Type** | **Production** or **Sandbox**. A gateway saved with **Test Only** turned on shows **Sandbox**. | | **Country** | The first two countries where the gateway is available, plus a count of any others, or a dash if none are set. Point to the count to see the full list. | | **Gateway** | The gateway provider, or **Unknown** if none is set. | | **MID** | The gateway's merchant ID, or a dash if none is set. | | **Purchase Type** | A badge for each transaction type the gateway accepts: **CIT**, **MIT**, or **MOTO**. See [Transaction types](#transaction-types). | Click a row to edit that gateway. The three-dot menu at the end of each row has **Edit** and **Delete**. ## Add a payment gateway Click **Add Payment Gateway**. The **Add Payment Gateway** panel opens. Enter a **Display Name**. The admin dashboard and storefront show this name. Enter a **Reporting Name**. CSV exports, event logs, and integrations use this name. Each **Reporting Name** must be unique among your company's payment accounts. Both names are required. Select a **Gateway**. You can't change it after you create the gateway. To use a different one later, add a new gateway. For an NMI gateway, a **Processor** menu also appears. It's optional. If you switch from an NMI gateway to a different gateway, the form clears **Display Name**, **Reporting Name**, and **Entity**. Under **Available Countries**, select at least one country. The list shows your company's countries, which you manage on [Countries](/help/admin/settings/countries). Enter the credentials and any other fields that appear for the gateway. See [Fields that depend on the gateway](#fields-that-depend-on-the-gateway). Turn on **Test Only** if this is a test gateway. The **Type** column then shows **Sandbox** instead of **Production**. **Active** is off by default for a new gateway. Turn it on to make the gateway eligible for payment routing. Inactive gateways are skipped by [payment routing](/help/admin/settings/payment-routing). A country can't have an active test gateway and an active live gateway at the same time. If saving fails because a gateway of the other kind is already active in one of the same countries, turn that gateway off first, or remove the overlapping country. Under **Transaction type eligibility**, check the kinds of payments this gateway may process. All three are checked for a new gateway. Keep at least one checked. See [Transaction types](#transaction-types). Click **Add Gateway**. A message confirms that the payment account was created, and the gateway appears in the table. If something is missing or invalid, the panel shows an error under the field, such as **At least one country must be selected**. ### Fields that depend on the gateway | Field | When it appears | | - | - | | **Processor** | NMI gateways. Optional. | | Credential fields | When the gateway needs credentials. Each gateway sets its own field names. Required fields have a red asterisk. | | **Merchant account routing** | Braintree gateways. Click **Add route**, select a **Currency**, and enter the **Merchant account ID** to use for it. Each currency can have only one route. With no routes, Braintree uses the gateway's default merchant account. | | **MID** | Every gateway. Optional. If you enter one, it must be exactly 15 letters or numbers. | | **Duplicate transaction window (seconds)** | NMI gateways. Optional. It overrides NMI's duplicate transaction window, which is 1,200 seconds (20 minutes) by default. Enter a whole number from 0 to 30,000. | | **Entity** | When your company has entities. It lists them by legal name. See [Entities](/help/admin/settings/entities). | | **Test Only** | Every gateway. | | **Apple Pay Enabled** | Every gateway. When it's on, these fields appear lower in the panel: **Merchant Identifier**, **Verified Domain**, **Domain Verification File**, **Merchant Certificate**, and **Merchant Key**. | Leave **Duplicate transaction window (seconds)** blank unless **Allow Merchant Override** is turned on in NMI. Otherwise, transactions fail with an error. ### Transaction types **Transaction type eligibility** sets which kinds of payments the gateway is allowed to process. | Option | What it covers | | - | - | | **CIT — E-commerce checkout** | Customer-initiated payments from the storefront checkout. | | **MIT — Recurring / subscriptions** | Merchant-initiated renewal charges on a subscription. | | **MOTO — Admin-initiated** | Mail-order and telephone-order payments entered by admins. | The **Purchase Type** column in the table shows the checked types as **CIT**, **MIT**, and **MOTO** badges. ## Edit a payment gateway Click the gateway's row, or open the three-dot menu at the end of the row and click **Edit**. The **Edit Payment Gateway** panel opens. Change the fields you need. You can't change the **Gateway**. Some saved credentials, such as keys and passwords, appear masked. Clicking a masked field clears it. Leave it empty to keep the saved value, or enter the whole new value to replace it. Saved values for **Domain Verification File**, **Merchant Certificate**, and **Merchant Key** don't appear. Leave those fields blank to keep them, or enter a new value to replace them. Click **Save Changes**. A saved gateway can also show these settings, depending on the gateway: * **\$0 Verification**, for gateways that support it. When it's on, the gateway uses its native \$0 verification instead of a \$1 authorization and void when a card is added. Gateways that require an entitlement for it, such as Braintree, fall back to the \$1 method when it isn't available. * **Stripe Connect**, for Stripe gateways. See [Connect a Stripe gateway](#connect-a-stripe-gateway). * **3DS Acquirer Settings**, for gateways that support 3DS. See [3DS acquirer settings](#3ds-acquirer-settings). ### 3DS acquirer settings For a gateway that supports 3DS, the **Edit Payment Gateway** panel ends with a collapsed **3DS Acquirer Settings** section. Click its heading to open it. * **Merchant Info (from Entity)** shows the **Legal Name**, **Country Code**, **MCC**, and **Website** used for this gateway. You can't edit them here. Without an **Entity**, they come from your company settings. To use different merchant info for this gateway, select an **Entity**. * **Acquirer Country Code** takes a three-letter country code, such as `USA`. * **Visa (Acquirer)** and **Mastercard (Acquirer)** each have **BIN** and **Merchant ID**. * **Amex (Acquirer)** and **Discover (Acquirer)** each have **BIN**, **Merchant ID**, **Requestor ID**, and **Requestor Name**. Each card network's section is collapsed until you click it. ### Connect a Stripe gateway For a saved Stripe gateway, the **Edit Payment Gateway** panel has a **Stripe Connect** section. It shows the connection status, such as **Authorization pending**, **Connected — verification in progress**, **Onboarding incomplete — requirements due**, **Connected — charges enabled**, or **Disconnected by merchant**. Once there's a Stripe account, it also shows the account ID, marked live or test. If the gateway isn't connected to Stripe yet, the section says so. Click the Stripe gateway's row. The **Edit Payment Gateway** panel opens. Click **Connect existing Stripe account** to connect a Stripe account you already have, or **Set up a new Stripe account** to create one through Stripe. Stripe opens in the same tab, so changes you haven't saved in the panel are lost. Complete the steps Stripe shows you. When Stripe sends you back to the admin, open **Gateways** in Settings again and click the gateway's row. The **Stripe Connect** section shows the new status. Click **Refresh status** to check it again. If the account is connected but onboarding isn't finished, click **Resume onboarding** to continue in Stripe. ## Delete a payment gateway Open the three-dot menu at the end of the gateway's row and click **Delete**. In the **Delete payment gateway?** dialog, click **Delete**. This can't be undone. ## Frequently asked questions Every gateway needs at least one transaction type. If none is checked, saving shows **Select at least one transaction type for this gateway**. Under **Transaction type eligibility**, check at least one type, and then save again. The gateway's countries changed after you opened the panel, so your save didn't go through. * If the message ends with **We reloaded it; please re-apply your changes.**, the panel now shows the current countries. Make your changes again and save. * If it ends with **Reload and try again.**, reload the page, open the gateway, and make your changes again. Under **Available Countries**, the panel shows **Couldn't load this account's countries.** You can't save the gateway until they load. Click **Retry**, and save after the countries appear. ## Related pages * [Settings](/help/admin/settings) * [APM](/help/admin/settings/apm) * [Countries](/help/admin/settings/countries) * [Entities](/help/admin/settings/entities) * [Payment Routing](/help/admin/settings/payment-routing) * [Roles](/help/admin/settings/roles) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.