medianfi-com Stripe Connect API

openapi: 3.2.0
info:
  title: Median Stripe Connect API
  version: 0.1.0
  description: Production-grade Node.js + Express API starter template
  license:
    name: Proprietary
servers:
- url: /api/v1
security: []
tags:
- name: Stripe Connect
paths:
  /companies/{companyId}/integrations/stripe/auth-url:
    parameters:
    - $ref: '#/components/parameters/companyId'
    post:
      operationId: createStripeAuthorizationUrl
      summary: Start the Stripe install flow (alias of install-link)
      description: Returns the Stripe marketplace install URL. Preflights the Stage-A GL compatibility guard for allowlisted companies, so a blocking account collision fails here rather than stranding a half-finished install.
      tags:
      - Stripe Connect
      security:
      - bearerAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StripeInstallLinkInput'
      responses:
        '200':
          description: Stripe install URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeInstallLinkResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/StripeGlAccountRebindRequired'
        '503':
          $ref: '#/components/responses/ServiceUnavailableJson'
  /companies/{companyId}/integrations/stripe/install-link:
    parameters:
    - $ref: '#/components/parameters/companyId'
    post:
      operationId: createStripeInstallLink
      summary: Start the Stripe install flow
      tags:
      - Stripe Connect
      security:
      - bearerAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StripeInstallLinkInput'
      responses:
        '200':
          description: Stripe install URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeInstallLinkResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/StripeGlAccountRebindRequired'
        '503':
          $ref: '#/components/responses/ServiceUnavailableJson'
  /companies/{companyId}/integrations/stripe/connection:
    parameters:
    - $ref: '#/components/parameters/companyId'
    get:
      operationId: getStripeConnectionStatus
      summary: Stripe connection status
      description: Read-only. For an allowlisted company the payload may carry `accountingBlock`, which separates codes that need accountant review (`accountCodes`) from codes that self-heal on the next sync through the audited adoption path (`adoptableCodes`).
      tags:
      - Stripe Connect
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Connection status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeConnectionStatusResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /companies/{companyId}/integrations/stripe/disconnect:
    parameters:
    - $ref: '#/components/parameters/companyId'
    post:
      operationId: disconnectStripe
      summary: Disconnect a Stripe account
      description: Marks the connection disconnected. Connection rows are never deleted — the imported transaction archive is bound to them.
      tags:
      - Stripe Connect
      security:
      - bearerAuth: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StripeDisconnectInput'
      responses:
        '200':
          description: Disconnected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeDisconnectResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /companies/{companyId}/integrations/stripe/sync:
    parameters:
    - $ref: '#/components/parameters/companyId'
    post:
      operationId: triggerStripeSync
      summary: Trigger an incremental Stripe sync
      tags:
      - Stripe Connect
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Sync counters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeSyncResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/StripeGlAccountRebindRequired'
components:
  schemas:
    StripeConnectionStatusResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          $ref: '#/components/schemas/StripeConnectionStatus'
    ApiErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          $ref: '#/components/schemas/ProblemDetail'
    StripeDisconnectResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
          - disconnected
          properties:
            disconnected:
              type: boolean
              const: true
    ProblemDetail:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
          description: 'For application errors, a stable UPPER_SNAKE machine code (for example `NOT_FOUND`, `FORECAST_NOT_FOUND`, `VALIDATION_ERROR`). Clients branch on this, never on `detail` wording. A few transport level responses use a short human title instead.

            '
        status:
          type: integer
        detail:
          type: string
          description: 'Human-readable explanation; correlate a failure with `traceId`. A NOT_FOUND-family 404 names the resource type (for example "Company not found"), not its id. Some legacy messages still include an id (tracked in #2666).

            '
        instance:
          type: string
        traceId:
          type: string
        retryAfter:
          type: integer
          minimum: 0
          description: Whole seconds until retry is allowed for a 429 response
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        extensions:
          type: object
          additionalProperties: true
    StripeDisconnectInput:
      type: object
      properties:
        connectionId:
          type: string
          format: uuid
          description: Which installed Stripe account to disconnect. Omitted disconnects the company's only connection.
      additionalProperties: false
    StripeAccountingBlock:
      type: object
      description: 'Stage-A Stripe GL guard state for the company (#1453A). Present only for companies on the guard allowlist.

        '
      required:
      - code
      - action
      - message
      - accountCodes
      - adoptableCodes
      properties:
        code:
          type: string
          const: STRIPE_GL_ACCOUNT_REBIND_REQUIRED
        action:
          type: string
          const: accountant_review
        message:
          type: string
        accountCodes:
          type: array
          description: 'Codes with a blocking collision, or missing while connected. These need accountant review and fail every connect, sync, and post.

            '
          items:
            type: string
        adoptableCodes:
          type: array
          description: 'Codes whose rows conform on accounting shape and name evidence. They are normalized automatically by the audited adoption path on the next connect or sync; no action is required.

            '
          items:
            type: string
    StripeSyncResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
          - synced
          - failed
          properties:
            synced:
              type: integer
              minimum: 0
            failed:
              type: integer
              minimum: 0
    StripeInstallLinkResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
          - installUrl
          - authorizationUrl
          properties:
            installUrl:
              type: string
              format: uri
            authorizationUrl:
              type: string
              format: uri
              description: Alias of installUrl, kept for the generic provider-connect client.
    StripeInstallLinkInput:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
          description: Model A legal entity to bind the connection to. Omitted when the company has a single entity.
        frontendReturnUri:
          type: string
          description: Relative app path the install callback returns the user to.
      additionalProperties: false
    StripeConnectionStatus:
      type: object
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - not_connected
          - auth_initiated
          - connected
          - importing
          - synced
          - error
        stripeAccountId:
          type:
          - string
          - 'null'
        livemode:
          type:
          - boolean
          - 'null'
        importedCount:
          type: integer
          minimum: 0
        backfillStartedAt:
          type:
          - string
          - 'null'
          format: date-time
        backfillCompletedAt:
          type:
          - string
          - 'null'
          format: date-time
        lastSyncAt:
          type:
          - string
          - 'null'
          format: date-time
        lastSyncAttemptAt:
          type:
          - string
          - 'null'
          format: date-time
        lastWebhookReceivedAt:
          type:
          - string
          - 'null'
          format: date-time
        errorMessage:
          type:
          - string
          - 'null'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/StripeConnectionAccountSummary'
        accountingBlock:
          $ref: '#/components/schemas/StripeAccountingBlock'
    StripeConnectionAccountSummary:
      type: object
      required:
      - connectionId
      - stripeAccountId
      - status
      - livemode
      - lastSyncAt
      - errorMessage
      properties:
        connectionId:
          type: string
          format: uuid
        stripeAccountId:
          type: string
        status:
          type: string
        livemode:
          type:
          - boolean
          - 'null'
        lastSyncAt:
          type:
          - string
          - 'null'
          format: date-time
        errorMessage:
          type:
          - string
          - 'null'
  responses:
    Forbidden:
      description: Insufficient permissions or not a company member
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    NotFound:
      description: Resource not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    StripeGlAccountRebindRequired:
      description: 'The Stage-A Stripe GL compatibility guard refused the call (STRIPE_GL_ACCOUNT_REBIND_REQUIRED). No connection, account, or journal entry was changed. `extensions.accountCodes` lists the codes an accountant must review and rebind; `extensions.adoptableCodes` lists codes that conform on accounting shape and self-heal on the next sync.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'
    ServiceUnavailableJson:
      description: Required sandbox provider configuration or service is unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    serviceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Persistent credential for the configured cloud-bookkeeping service principal. The key must carry accountant:* and is accepted only on accountant operations that explicitly list this scheme. Ordinary API keys, and service keys presented to bearer-only operations, are denied.

        '
    refreshSessionCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_refresh
      description: 'Exact production HttpOnly refresh-session cookie. Local non-secure development uses median_refresh.

        '
    passkeyEnrollmentGrantCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_passkey_enrollment
      description: 'Exact production HttpOnly passkey-enrollment grant cookie. Local non-secure development uses median_passkey_enrollment.

        '
    webAuthnCeremonyCookie:
      type: apiKey
      in: cookie
      name: __Secure-median_webauthn
      description: 'Exact production HttpOnly WebAuthn ceremony cookie. Local non-secure development uses median_webauthn.

        '
x-median-quarantined-authorities:
  decision: ADR-0001-model-a
  runtimeStatus: unmounted
  description: 'Migrations 267-272 modeled legal entities as separate company tenants. These paths are not runtime API authority while their preserved accounting math is re-keyed to legal entities inside one company workspace.

    '
  paths:
  - /companies/{companyId}/consolidation-groups
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/report-rollups
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/report-rollups/{rollupId}
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/translation-adjustments
  - /companies/{companyId}/consolidation-groups/{groupId}/versions/{groupVersionId}/translation-adjustments/{adjustmentId}
x-median-demo-parity-customer-surface:
  runtimeStatus: mounted-lifecycle-only
  description: 'v2 customer-app capabilities available to JWT-authenticated members of any active or test company — the v2 app is the product, not a rollout cohort, so no allowlist applies to the markerless path. Production customer calls omit X-Median-App-Surface. Test-company calls may carry X-Median-App-Surface: qa to select the QA bundle; that marker branch alone still requires membership in CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS. An API key, unknown marker, malformed company id, inactive company, missing gate dependency, or failed company lookup receives the standard hidden-resource 404 contract. The held surfaces riding these prefixes (AR/AP, Forecast, Insights) carry their own additional allowlist gate — see x-median-forecast-hold and x-median-ar-ap-hold.

    '
  headerContract: '#/components/parameters/demoParityCustomerAppSurface'
  routePrefixes:
  - /companies/{companyId}/ar
  - /companies/{companyId}/ap
  - /companies/{companyId}/customers
  - /companies/{companyId}/vendors
  - /companies/{companyId}/contracts
  - /companies/{companyId}/receivables
  - /companies/{companyId}/entities
  - /companies/{companyId}/currencies
  - /companies/{companyId}/reporting-scopes
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/rollups
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/translation-adjustments
  - /companies/{companyId}/presentation-report-snapshots
  - /companies/{companyId}/reporting-trial-balances
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/trial-balances
  - /companies/{companyId}/reporting-scopes/{reportingScopeId}/versions/{versionId}/intercompany
  - /companies/{companyId}/weekly-email
  - /companies/{companyId}/forecast
  - /companies/{companyId}/books
  - /companies/{companyId}/sub-ledgers
x-median-forecast-hold:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Forecast is held. Beyond the lifecycle-only customer surface above, every operation under the prefix below also requires the company to appear in the held-surface allowlist CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS — the one operator-set list that opens AR/AP, Forecast and Insights (the legacy CUSTOMER_APP_FORECAST_COMPANY_IDS variable is no longer consulted). It is empty by default, so the v2 rollout alone never exposes Forecast. A company off the list receives the same hidden-resource 404 contract as one for which the surface does not exist. The auth-context featureFlags key `forecast` mirrors this verdict for the customer app shell.

    '
  featureFlag: forecast
  routePrefixes:
  - /companies/{companyId}/forecast
x-median-ar-ap-hold:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Receivables/Payables are held behind TWO required authorities. Beyond the lifecycle-only customer surface above, every operation under the prefixes below requires the company to appear in the held-surface allowlist CUSTOMER_APP_DEMO_PARITY_COMPANY_IDS (requireDemoParityAllowlistedCompany) AND to satisfy the company_subledger_flags conversion chain (requireArApItemsEnabled — the same authority the public /pay page, aging and the accountant portal consult); failing either answers the opaque 404. The auth-context featureFlags key `arApItems` mirrors exactly that conjunction, resolved server-side, so the customer shell hides the Receivables/Payables nav and pages instead of offering menu entries these routes 404. Default is FALSE for every company while the list is empty or the conversion has not run.

    '
  featureFlag: arApItems
  routePrefixes:
  - /companies/{companyId}/ar
  - /companies/{companyId}/ap
  - /companies/{companyId}/customers
  - /companies/{companyId}/vendors
  - /companies/{companyId}/contracts
  - /companies/{companyId}/receivables
x-median-demo-parity-qa-only:
  runtimeStatus: mounted-only-with-server-gate
  description: 'Strict test-company-only routes. Every interactive call requires X-Median-App-Surface: qa in addition to JWT authentication, the server allowlist, and persisted client_status=test. A copied header, API key, active company, missing gate dependency, or failed company lookup receives the standard hidden-resource 404 contract.

    '
  headerContract: '#/components/parameters/qaAppSurface'
  routePrefixes:
  - /companies/{companyId}/gl-accounts/{id}/monetary-classification
  - /companies/{companyId}/fx-account-roles
  - /companies/{companyId}/gl-periods/{periodId}/fx-revaluation
  - /accountant/companies/{customerId}/gl-accounts/{id}/monetary-classification
  - /accountant/companies/{customerId}/fx-account-roles
  - /accountant/companies/{customerId}/gl-periods/{periodId}/fx-revaluation
  - /accountant/companies/{customerId}/ar/{id}
  - /accountant/companies/{customerId}/ap/{id}
x-median-onboarding-v3-surface:
  runtimeStatus: promoted
  promotionFlag: ONBOARDING_V3_QA_ONLY=false
  description: 'Promoted. The deployment this contract describes runs ONBOARDING_V3_QA_ONLY=false, so none of the onboarding-v3 auth, pricing, or setup paths below requires X-Median-App-Surface: qa. An unmarked request is served and reaches ordinary authentication, so an unauthenticated call now answers 401 rather than the hidden-resource 404. Mounting is still conditional: with ONBOARDING_V3_ENABLED false every path below returns the hidden-resource 404 before body parsing or authentication. The header stays defined and is still honoured, because a deployment left at ONBOARDING_V3_QA_ONLY=true keeps requiring it on every path below and 404s unmarked traffic; setting that flag back to true is the rollback. On either setting the header is a pre-company bundle marker, never tenant authorization.

    '
  headerContract: '#/components/parameters/onboardingV3QaSurface'
  routePaths:
  - /auth/otp/start
  - /auth/otp/verify
  - /auth/passkeys/register/options
  - /auth/passkeys/register/verify
  - /auth/passkeys/assert/options
  - /auth/passkeys/assert/verify
  - /onboarding/v3/quote
  - /onboarding/v3/offer/resolve
  - /onboarding/v3/flow
  - /onboarding/v3/setup-intent
  - /onboarding/v3/subscribe
  - /onboarding/v3/test-account-activation
  - /onboarding/v3/checkout-session
  - /onboarding/v3/checkout-session/complete
  - /onboarding/v3/setup-state
  - /onboarding/v3/delegate-invites
  - /onboarding/v3/delegate-invites/{inviteId}
  - /onboarding/v3/delegate/resolve
  - /onboarding/v3/delegate
  - /onboarding/v3/task-context
  - /onboarding/v3/delegate/task-context
  - /onboarding/v3/banks/plaid/link-token
  - /onboarding/v3/banks/plaid/exchange
  - /onboarding/v3/banks/commit
  - /onboarding/v3/documents/google-workspace/auth-url
  - /onboarding/v3/documents/google-workspace/callback
  - /onboarding/v3/books/quickbooks/auth-url
  - /onboarding/v3/books/quickbooks/callback
  - /onboarding/v3/books/xero/auth-url
  - /onboarding/v3/books/xero/callback
  - /onboarding/v3/welcome-call
  - /onboarding/v3/welcome-call/embed
  - /onboarding/v3/books-progress
  - /onboarding/v3/books/open
  - /companies/{companyId}/onboarding/v3/questions
  - /companies/{companyId}/onboarding/v3/questions/{questionId}/answer
  - /companies/{companyId}/onboarding/v3/review-items