> ## Documentation Index
> Fetch the complete documentation index at: https://omniflow-vpn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Post v1panelsettingsproviders recurring

> Requires settings.write. Records a capability test and, only on a pass, may enable automatic charging. Refused for an adapter that cannot bind a payment method, whatever the test reported.



## OpenAPI

````yaml https://raw.githubusercontent.com/kewldan/omniflow/main/api/openapi.yaml post /v1/panel/settings/providers/{provider}/recurring
openapi: 3.0.3
info:
  title: Omniflow API
  version: 1.0.0
  description: >-
    Customer, commerce, payment, wallet, fulfillment, and operations API for
    Omniflow.
servers: []
security: []
paths:
  /v1/panel/settings/providers/{provider}/recurring:
    post:
      tags:
        - panel
      description: >-
        Requires settings.write. Records a capability test and, only on a pass,
        may enable automatic charging. Refused for an adapter that cannot bind a
        payment method, whatever the test reported.
      operationId: configurePanelRecurring
      parameters:
        - in: path
          name: provider
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/CSRFToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PanelRecurringTest'
      responses:
        '200':
          description: Saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PanelProviderSettings'
        '403':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    CSRFToken:
      in: header
      name: X-CSRF-Token
      required: true
      description: >-
        Echoes the token from the current session. Required on every unsafe
        method.
      schema:
        type: string
  schemas:
    PanelRecurringTest:
      type: object
      required:
        - passed
        - enable
      properties:
        merchantId:
          type: string
        passed:
          type: boolean
        enable:
          type: boolean
          description: >-
            Only honoured alongside a passing test and an adapter that declares
            the capability.
    PanelProviderSettings:
      type: object
      required:
        - provider
        - merchantId
        - enabled
        - displayOrder
        - credentialsSet
        - webhookSecretSet
        - adapterRecurring
        - recurringEnabled
        - recurringTestStatus
        - connectionStatus
        - webhookStatus
        - updatedAt
      properties:
        provider:
          type: string
        merchantId:
          type: string
        enabled:
          type: boolean
        displayOrder:
          type: integer
        credentialsSet:
          type: boolean
          description: >-
            Whether a credential is stored. The credential itself is never
            returned.
        webhookSecretSet:
          type: boolean
        adapterRecurring:
          type: boolean
          description: >-
            What the compiled-in adapter declares. The operator switch can only
            narrow this.
        recurringEnabled:
          type: boolean
        recurringTestStatus:
          type: string
          enum:
            - untested
            - passed
            - failed
        recurringTestedAt:
          type: string
          format: date-time
        connectionStatus:
          type: string
          enum:
            - unknown
            - healthy
            - failing
        connectionCheckedAt:
          type: string
          format: date-time
        connectionErrorCode:
          type: string
        webhookStatus:
          type: string
          enum:
            - unknown
            - healthy
            - failing
        webhookLastEventAt:
          type: string
          format: date-time
        webhookLastErrorCode:
          type: string
        updatedAt:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        request_id:
          type: string
  responses:
    Problem:
      description: Request failed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'

````

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