> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. # Company Transactions company transactions > Lists the current company's payment transactions: every request sent to a payment gateway, such as authorizations, captures, purchases, refunds and voids. Results are newest first unless `sorted_by` says otherwise, and are always limited to the caller's company. Pagination is cursor-based: send `page[limit]` (1-100, default 20) and pass `meta.pagination.next_cursor` back as `page[cursor]`. Filter with the query parameters below; `filter_options` lists the accepted values. Requires a company admin Bearer token with the `payment_accounts.view` permission. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v202506/company_transactions openapi: 3.1.0 info: title: Fluid Admin v2025-06 API version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/v202506/company_transactions: get: tags: - company-transactions summary: Company Transactions company transactions description: >- Lists the current company's payment transactions: every request sent to a payment gateway, such as authorizations, captures, purchases, refunds and voids. Results are newest first unless `sorted_by` says otherwise, and are always limited to the caller's company. Pagination is cursor-based: send `page[limit]` (1-100, default 20) and pass `meta.pagination.next_cursor` back as `page[cursor]`. Filter with the query parameters below; `filter_options` lists the accepted values. Requires a company admin Bearer token with the `payment_accounts.view` permission. operationId: admin_v2025_06_company_transactions_get parameters: - name: page in: query required: false style: deepObject explode: true description: Cursor pagination parameters. schema: type: object properties: cursor: type: - string - 'null' limit: type: integer minimum: 1 maximum: 100 default: 20 - name: sorted_by in: query required: false description: >- A sortable column with an _asc or _desc suffix, as on /api/v202506/transactions. An unrecognised value falls back to created_at_desc rather than erroring. example: created_at_desc schema: type: string - name: country_code in: query required: false description: >- Filter by the payment's billing country, as an ISO 3166-1 alpha-2 code. Accepted values are listed by the filter_options operation. example: US schema: type: string - name: currency in: query required: false description: Filter by currency code. example: USD schema: type: string - name: status in: query required: false description: Filter by payment status. example: success schema: type: string - name: payment_action in: query required: false description: Filter by payment action. example: capture schema: type: string - name: integration in: query required: false description: Filter by payment integration class. example: CreditCard schema: type: string - name: gateway in: query required: false description: >- Filter by the ActiveMerchant gateway class that processed the payment. example: ActiveMerchant::Billing::NmiGateway schema: type: string - name: order_source in: query required: false description: Filter by the source of the originating order. example: web schema: type: string - name: type in: query required: false description: Filter by whether the payment was live or a test transaction. example: live schema: type: string enum: - test - live - name: order_id in: query required: false description: Filter by order id or order token. schema: type: string - name: cart_id in: query required: false description: Filter by cart id or cart token. schema: type: string - name: transaction_id in: query required: false description: Filter by gateway transaction id. schema: type: string - name: customer_id in: query required: false description: Filter by customer id. schema: type: integer responses: '200': description: Success content: application/json: example: transactions: - id: 5520931 slug: fpi_3kq8v2mz7c1xw9rb4tn6ha action: capture status: success company_id: 1405 company_name: Dunder Mifflin Paper Company customer_id: 48213 customer_name: Holly Flax cart_id: 881204 subscription_id: null card_id: 20117 parent_id: 5520930 amount: '54.99' currency_code: USD country_code: US integration_class: CreditCard adapter_class: ActiveMerchant::Billing::NmiGateway transaction_id: '10284771653' refunded_amount: '0.0' last_refunded_at: null voided_at: null created_at: '2026-09-29T16:42:07.318Z' updated_at: '2026-09-29T16:42:07.940Z' response_status: null response_message: SUCCESS decline_class: null processing_fee: 1.89 platform_fee: 0.55 fee_status: unpaid invoice_id: null cart_token: ct_7RkPz3WfLq9TnX2bVh5cJd latency: 0.62 seconds order_source: web test_transaction: false card_display: '**** **** **** 4242' wallet_type: null payment_account: id: 272 uuid: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd name: NMI display_name: Credit Card reporting_name: Dunder Mifflin NMI integration_class: CreditCard adapter_class: ActiveMerchant::Billing::NmiGateway - id: 5520877 slug: fpi_9wd2hx5ne0qk7tz3mb1vsa action: purchase status: declined company_id: 1405 company_name: Dunder Mifflin Paper Company customer_id: 48197 customer_name: Jan Levinson cart_id: 881150 subscription_id: null card_id: 20094 parent_id: null amount: '109.98' currency_code: USD country_code: US integration_class: CreditCard adapter_class: ActiveMerchant::Billing::NmiGateway transaction_id: '10284769021' refunded_amount: '0.0' last_refunded_at: null voided_at: null created_at: '2026-09-29T15:18:44.102Z' updated_at: '2026-09-29T15:18:45.377Z' response_status: '202' response_message: Insufficient funds decline_class: balance processing_fee: null platform_fee: null fee_status: null invoice_id: null cart_token: ct_2HmVq8XcTk4RsN9pLb6WfY latency: 1.27 seconds order_source: web test_transaction: false card_display: '**** **** **** 0119' wallet_type: null payment_account: id: 272 uuid: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd name: NMI display_name: Credit Card reporting_name: Dunder Mifflin NMI integration_class: CreditCard adapter_class: ActiveMerchant::Billing::NmiGateway meta: request_id: c0a8012e-7f3b-4d6a-9e21-5b8d4f2a6c17 timestamp: '2026-09-30T14:15:22Z' pagination: cursor: null limit: 20 prev_cursor: null next_cursor: >- eyJwYXltZW50cy5jcmVhdGVkX2F0IjoiMjAyNi0wOS0yOVQxNToxODo0NC4xMDJaIn0 schema: type: object properties: transactions: type: array items: type: object properties: id: type: integer slug: type: string action: type: string status: type: string company_id: type: integer company_name: type: string customer_id: type: - integer - 'null' customer_name: type: - string - 'null' cart_id: type: - integer - 'null' subscription_id: type: - integer - 'null' card_id: type: - integer - 'null' parent_id: type: - integer - 'null' amount: type: string currency_code: type: string country_code: type: - string - 'null' description: >- ISO 3166-1 alpha-2 billing country, frozen at charge time. Null when the payment had no billing address to read, and on rows written before the field existed. integration_class: type: string adapter_class: type: - string - 'null' transaction_id: type: - string - 'null' refunded_amount: type: string last_refunded_at: type: - string - 'null' voided_at: type: - string - 'null' created_at: type: string format: date-time updated_at: type: string format: date-time response_status: type: - string - 'null' response_message: type: - string - 'null' decline_class: type: - string - 'null' description: >- The named reason behind a decline: balance, soft_issuer, card_activation, card_gone, integration, never_retry, stop_requested, unknown or unrecognized. Derived by the platform from the gateway response, so callers do not have to pattern-match response_message themselves. Null on a successful payment and on declines recorded before classification. processing_fee: type: - number - 'null' platform_fee: type: - number - 'null' fee_status: type: - string - 'null' invoice_id: type: - integer - 'null' cart_token: type: - string - 'null' latency: type: - string - 'null' order_source: type: - string - 'null' test_transaction: type: boolean card_display: type: - string - 'null' wallet_type: type: - string - 'null' description: >- Digital wallet type ("apple_pay", "google_pay") for a wallet-tokenized card payment. Null when the wallet cannot be attributed to this row — non-funding actions (authorize, refund, void), an unsuccessful charge, an order or cart with more than one funding charge, or a non-wallet payment method. example: apple_pay payment_account: type: object properties: id: type: integer uuid: type: string name: type: string display_name: type: string reporting_name: type: string integration_class: type: string adapter_class: type: - string - 'null' meta: $ref: '#/components/schemas/Meta' additionalProperties: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' security: - bearer_auth: [] components: schemas: Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: type: object description: >- Rotulus cursor-pagination metadata (Api::MetaPagination#to_h), present on cursor-paginated responses such as GET /api/v2025-06/prices. total_count is only present when the endpoint opts into a total count. properties: cursor: type: - string - 'null' limit: type: integer prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' total_count: type: integer UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer ````