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

# Desabilitar assinatura de webhook

> Interrompe a entrega imediatamente e preserva a assinatura para reativação no painel.



## OpenAPI

````yaml /openapi/korbit-public-v1.json post /v1/webhook-subscriptions/{id}/disable
openapi: 3.1.0
info:
  title: Korbit API
  version: 1.0.0
  description: >-
    API de pagamentos da Korbit para merchants: PIX, cartão (com 3DS),
    assinaturas, checkout por link, payouts, antecipações e refunds — com
    idempotência, webhooks assinados e ambiente sandbox.
  contact:
    name: Suporte Korbit
    email: suporte@korbit.com.br
servers:
  - url: https://api.korbit.com.br
    description: Produção (chaves kbt_live_)
  - url: https://api-test.korbit.com.br
    description: Sandbox (chaves kbt_test_)
security:
  - bearerAuth: []
tags:
  - name: Antecipações
  - name: Assinaturas
  - name: Atividade
  - name: Catálogo
  - name: Chaves de API
  - name: Checkout
  - name: Clientes e Pedidos
  - name: Pagamentos
  - name: Refunds e Disputas
  - name: Saldo e Saques
  - name: Sandbox
  - name: Webhooks
paths:
  /v1/webhook-subscriptions/{id}/disable:
    post:
      tags:
        - Webhooks
      summary: Desabilitar assinatura de webhook
      description: >-
        Interrompe a entrega imediatamente e preserva a assinatura para
        reativação no painel.
      operationId: disableMerchantWebhookSubscription
      parameters:
        - schema:
            type: string
            format: uuid
          in: path
          name: id
          required: true
        - schema:
            type: string
            minLength: 1
            maxLength: 255
          in: header
          name: idempotency-key
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - createdAt
                  - environment
                  - eventTypes
                  - id
                  - status
                  - updatedAt
                  - url
                properties:
                  createdAt:
                    type: string
                    format: date-time
                  environment:
                    type: string
                    enum:
                      - live
                      - test
                  eventTypes:
                    type: array
                    minItems: 1
                    uniqueItems: true
                    items:
                      type: string
                      enum:
                        - payment.created.v1
                        - payment.requires_action.v1
                        - payment.succeeded.v1
                        - payment.failed.v1
                        - refund.requested.v1
                        - refund.updated.v1
                        - refund.succeeded.v1
                        - payout.requested.v1
                        - payout.updated.v1
                        - dispute.opened.v1
                        - dispute.updated.v1
                        - merchant.kyc.updated.v1
                        - merchant.status.updated.v1
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - ACTIVE
                      - DISABLED
                      - ERROR
                      - PENDING
                  updatedAt:
                    type: string
                    format: date-time
                  url:
                    type: string
                    format: uri
                    maxLength: 2000
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - createdAt
                  - environment
                  - eventTypes
                  - id
                  - status
                  - updatedAt
                  - url
                properties:
                  createdAt:
                    type: string
                    format: date-time
                  environment:
                    type: string
                    enum:
                      - live
                      - test
                  eventTypes:
                    type: array
                    minItems: 1
                    uniqueItems: true
                    items:
                      type: string
                      enum:
                        - payment.created.v1
                        - payment.requires_action.v1
                        - payment.succeeded.v1
                        - payment.failed.v1
                        - refund.requested.v1
                        - refund.updated.v1
                        - refund.succeeded.v1
                        - payout.requested.v1
                        - payout.updated.v1
                        - dispute.opened.v1
                        - dispute.updated.v1
                        - merchant.kyc.updated.v1
                        - merchant.status.updated.v1
                  id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - ACTIVE
                      - DISABLED
                      - ERROR
                      - PENDING
                  updatedAt:
                    type: string
                    format: date-time
                  url:
                    type: string
                    format: uri
                    maxLength: 2000
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - detail
                  - instance
                  - requestId
                  - status
                  - title
                  - type
                properties:
                  code:
                    type: string
                  detail:
                    type: string
                  instance:
                    type: string
                  requestId:
                    type: string
                  status:
                    type: integer
                    minimum: 400
                    maximum: 599
                  title:
                    type: string
                  type:
                    type: string
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Korbit API key

````

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