> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update provider settings

> Reads current stored configuration; completed does not establish current provider health. The catalog distinguishes dashboard actions from implemented API actions. Region and installation eligibility mirror existing web rules. Settings affect the team across credential data modes. Current authorized members can read; mutations recheck current team/owning-account administrator authority for user credentials. API keys retain their current team scope.

Only fields for the selected provider are accepted. Existing non-bank connection required. Bank instructions require country and holder name, plus a valid CLABE for MEX; saving marks them configured without verifying bank ownership. Existing installation limit applies to first bank configuration. No credentials or worker state are replaced.



## OpenAPI

````yaml openapi.json PATCH /teams/{id}/integrations/{provider}/settings
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /teams/{id}/integrations/{provider}/settings:
    patch:
      tags:
        - Account Integrations
      summary: Update provider settings
      description: >-
        Reads current stored configuration; completed does not establish current
        provider health. The catalog distinguishes dashboard actions from
        implemented API actions. Region and installation eligibility mirror
        existing web rules. Settings affect the team across credential data
        modes. Current authorized members can read; mutations recheck current
        team/owning-account administrator authority for user credentials. API
        keys retain their current team scope.


        Only fields for the selected provider are accepted. Existing non-bank
        connection required. Bank instructions require country and holder name,
        plus a valid CLABE for MEX; saving marks them configured without
        verifying bank ownership. Existing installation limit applies to first
        bank configuration. No credentials or worker state are replaced.
      operationId: updateAccountIntegrationSettings
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: provider
          in: path
          required: true
          schema:
            type: string
            enum:
              - stripe
              - adyen
              - paypal
              - zettle
              - conekta
              - openpay
              - clip
              - clockpms
              - pagoralia
              - dlocal
              - woocommerce
              - mercadopago
              - mercadolibre
              - airtable
              - shopify
              - bank
              - sheets
              - netsuite
              - whatsapp
              - zapier
              - whmcs
              - hilos
              - sat
              - sat_download
              - factus
      requestBody:
        required: true
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/IntegrationStripeSettingsInput'
                - $ref: '#/components/schemas/IntegrationAdyenSettingsInput'
                - $ref: '#/components/schemas/IntegrationPaypalSettingsInput'
                - $ref: '#/components/schemas/IntegrationConektaSettingsInput'
                - $ref: '#/components/schemas/IntegrationOpenpaySettingsInput'
                - $ref: '#/components/schemas/IntegrationClipSettingsInput'
                - $ref: '#/components/schemas/IntegrationClockpmsSettingsInput'
                - $ref: '#/components/schemas/IntegrationPagoraliaSettingsInput'
                - $ref: '#/components/schemas/IntegrationDlocalSettingsInput'
                - $ref: '#/components/schemas/IntegrationWoocommerceSettingsInput'
                - $ref: '#/components/schemas/IntegrationMercadopagoSettingsInput'
                - $ref: '#/components/schemas/IntegrationShopifySettingsInput'
                - $ref: '#/components/schemas/IntegrationBankSettingsInput'
            examples:
              disableStripeAutomation:
                summary: For provider=stripe
                value:
                  automatic_invoicing: false
              bankInstructions:
                summary: For provider=bank
                value:
                  country: MEX
                  holder_name: Example Company
                  clabe: '032180000118359719'
      responses:
        '200':
          description: Stored integration state
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/AccountIntegrationDetail'
                  timestamp:
                    type: number
                required:
                  - success
                  - data
                  - timestamp
        '400':
          description: >-
            Invalid identifier, field, empty patch, bank identity, or CLABE;
            provider requires its dedicated settings workflow.
        '401':
          description: Authentication required.
        '403':
          description: Current role or existing installation entitlement required.
        '404':
          description: Team or provider not found in authorized scope.
        '409':
          description: Integration is not configured or team is pending deletion.
      security:
        - bearerAuth: []
components:
  schemas:
    IntegrationStripeSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
        test_only:
          type: boolean
        automatic_refunds:
          type: boolean
        ppd_flow:
          type: boolean
        use_provider_exchange_rate:
          type: boolean
        convert_payments_to_currency:
          type: string
          nullable: true
          pattern: ^[A-Z]{3}$
        default_payment_method:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{2}$
        customer_balance_payment_method:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{2}$
        stripe_payment_method:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{2}$
      minProperties: 1
      description: >-
        Settings accepted only for provider=stripe. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationAdyenSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
        test_only:
          type: boolean
        ppd_flow:
          type: boolean
        use_provider_exchange_rate:
          type: boolean
        convert_payments_to_currency:
          type: string
          nullable: true
          pattern: ^[A-Z]{3}$
      minProperties: 1
      description: >-
        Settings accepted only for provider=adyen. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationPaypalSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
        test_only:
          type: boolean
        service_description:
          type: string
          nullable: true
          maxLength: 1000
        payment_form:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{2}$
      minProperties: 1
      description: >-
        Settings accepted only for provider=paypal. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationConektaSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=conekta. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationOpenpaySettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=openpay. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationClipSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=clip. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationClockpmsSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=clockpms. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationPagoraliaSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=pagoralia. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationDlocalSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=dlocal. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationWoocommerceSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=woocommerce. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationMercadopagoSettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
      minProperties: 1
      description: >-
        Settings accepted only for provider=mercadopago. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationShopifySettingsInput:
      type: object
      additionalProperties: false
      properties:
        automatic_invoicing:
          type: boolean
        default_payment_form:
          type: string
          nullable: true
          maxLength: 2
          pattern: ^\d{2}$
      minProperties: 1
      description: >-
        Settings accepted only for provider=shopify. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    IntegrationBankSettingsInput:
      type: object
      additionalProperties: false
      properties:
        bic:
          type: string
          nullable: true
          maxLength: 20
        clabe:
          type: string
          nullable: true
          pattern: ^\d{18}$
        country:
          type: string
          pattern: ^[A-Z]{3}$
        holder_name:
          type: string
          nullable: true
          maxLength: 200
        iban:
          type: string
          nullable: true
          maxLength: 34
        help:
          type: string
          nullable: true
          maxLength: 2000
        swift:
          type: string
          nullable: true
          maxLength: 20
        voucher_required:
          type: boolean
        account_number:
          type: string
          nullable: true
          maxLength: 64
        routing_number:
          type: string
          nullable: true
          maxLength: 32
      minProperties: 1
      description: >-
        Settings accepted only for provider=bank. Fields omitted from the
        request remain unchanged. Read the provider state after a write.
        Nullable text clears; boolean null is rejected.
    AccountIntegrationDetail:
      allOf:
        - $ref: '#/components/schemas/AccountIntegrationState'
        - type: object
          required:
            - team_id
          properties:
            team_id:
              type: string
    AccountIntegrationState:
      type: object
      additionalProperties: false
      properties:
        provider:
          type: string
          enum:
            - stripe
            - adyen
            - paypal
            - zettle
            - conekta
            - openpay
            - clip
            - clockpms
            - pagoralia
            - dlocal
            - woocommerce
            - mercadopago
            - mercadolibre
            - airtable
            - shopify
            - bank
            - sheets
            - netsuite
            - whatsapp
            - zapier
            - whmcs
            - hilos
            - sat
            - sat_download
            - factus
        label:
          type: string
        category:
          type: string
          enum:
            - payments
            - commerce
            - automation
            - erp
            - messaging
            - fiscal
        mode_scope:
          type: string
          enum:
            - team_shared
            - connection_mode
            - live_test
        source:
          type: string
          enum:
            - stored_configuration
        completed:
          type: boolean
        region_available:
          type: boolean
        regions:
          type: array
          nullable: true
          items:
            type: string
        installation:
          type: object
          additionalProperties: false
          properties:
            allowed:
              type: boolean
            reason:
              type: string
              nullable: true
            limit:
              type: number
              nullable: true
            used:
              type: number
          required:
            - allowed
            - reason
            - limit
            - used
        settings:
          type: object
          additionalProperties: false
          properties:
            automatic_invoicing:
              type: boolean
              nullable: true
            test_only:
              type: boolean
              nullable: true
            automatic_refunds:
              type: boolean
              nullable: true
            ppd_flow:
              type: boolean
              nullable: true
            use_provider_exchange_rate:
              type: boolean
              nullable: true
            convert_payments_to_currency:
              type: string
              nullable: true
              pattern: ^[A-Z]{3}$
            default_payment_method:
              type: string
              nullable: true
              maxLength: 2
              pattern: ^\d{2}$
            customer_balance_payment_method:
              type: string
              nullable: true
              maxLength: 2
              pattern: ^\d{2}$
            stripe_payment_method:
              type: string
              nullable: true
              maxLength: 2
              pattern: ^\d{2}$
            service_description:
              type: string
              nullable: true
              maxLength: 1000
            payment_form:
              type: string
              nullable: true
              maxLength: 2
              pattern: ^\d{2}$
            default_payment_form:
              type: string
              nullable: true
              maxLength: 2
              pattern: ^\d{2}$
            bic:
              type: string
              nullable: true
              maxLength: 20
            clabe:
              type: string
              nullable: true
              pattern: ^\d{18}$
            country:
              type: string
              nullable: true
              pattern: ^[A-Z]{3}$
            holder_name:
              type: string
              nullable: true
              maxLength: 200
            iban:
              type: string
              nullable: true
              maxLength: 34
            help:
              type: string
              nullable: true
              maxLength: 2000
            swift:
              type: string
              nullable: true
              maxLength: 20
            voucher_required:
              type: boolean
              nullable: true
            account_number:
              type: string
              nullable: true
              maxLength: 64
            routing_number:
              type: string
              nullable: true
              maxLength: 32
          description: >-
            Only the fields supported by this provider are present. Unset stored
            values are null, including booleans.
        connected_at:
          type: number
          nullable: true
        last_sync_at:
          type: number
          nullable: true
        web_actions:
          type: array
          items:
            type: string
        api_actions:
          type: array
          items:
            type: string
        team_id:
          type: string
          description: Present on a single-provider response; omitted on catalog entries.
      required:
        - provider
        - label
        - category
        - mode_scope
        - source
        - completed
        - region_available
        - regions
        - installation
        - settings
        - connected_at
        - last_sync_at
        - web_actions
        - api_actions
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

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