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

# Configurar webhook

> **Requer Bearer JWT**. URL HTTPS + exatamente UM evento (array com 1 item) + secret opcional para assinatura HMAC. Se `secret` for omitido, o NTX Pay gera um automaticamente e retorna na resposta — guarde com segurança.



## OpenAPI

````yaml post /api/webhooks-config
openapi: 3.0.0
info:
  title: NTX Pay Public API — México
  description: >-
    API Pública NTX Pay para integração com SPEI (cash-in/cash-out) no México.
    Todos os valores monetários são expressos em centavos MXN.
  version: 1.0.0
  contact: {}
servers:
  - url: https://sandbox.mx.ntxpay.com
    description: Sandbox
security: []
tags:
  - name: auth
    description: Geração de token via certificado X.509 + clientId/clientSecret
  - name: SPEI
    description: >-
      Transferências interbancárias instantâneas mexicanas (cash-in via CLABE
      descartável; cash-out para CLABE)
  - name: Balance
    description: Consulta de saldo da conta (centavos MXN)
  - name: Webhooks Config
    description: Configuração de webhooks para notificações de eventos
paths:
  /api/webhooks-config:
    post:
      tags:
        - Webhooks Config
      summary: Configurar webhook
      description: >-
        **Requer Bearer JWT**. URL HTTPS + exatamente UM evento (array com 1
        item) + secret opcional para assinatura HMAC. Se `secret` for omitido, o
        NTX Pay gera um automaticamente e retorna na resposta — guarde com
        segurança.
      operationId: WebhooksConfigController_setup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupWebhookInputDto'
      responses:
        '201':
          description: Webhook configurado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupWebhookOutputDto'
        '400':
          description: Payload inválido
        '401':
          description: Token inválido
        '502':
          description: Serviço temporariamente indisponível
      security:
        - bearer: []
components:
  schemas:
    SetupWebhookInputDto:
      type: object
      required:
        - url
        - events
      properties:
        url:
          type: string
          format: uri
          description: URL HTTPS que receberá os webhooks
          example: https://example.com/webhooks/mx
        events:
          type: array
          minItems: 1
          maxItems: 1
          description: >-
            Um webhook assina **exatamente UM** evento. O campo é um array por
            compatibilidade de contrato, mas deve conter um único item. Use
            `all` (Geral) para receber todos os eventos em uma única URL.
          items:
            type: string
            enum:
              - cash_in
              - cash_out
              - refund_in
              - refund_out
              - internal_transfer
              - all
          example:
            - cash_in
        secret:
          type: string
          minLength: 8
          maxLength: 128
          description: >-
            Secret HMAC para assinatura. Se omitido, o NTX Pay gera
            automaticamente.
          example: whsec_abc123
    SetupWebhookOutputDto:
      type: object
      properties:
        id:
          type: integer
          example: 42
        url:
          type: string
          example: https://example.com/webhooks/mx
        events:
          type: array
          items:
            type: string
          example:
            - cash_in
        isActive:
          type: boolean
          example: true
        secret:
          type: string
          description: >-
            Secret gerado pelo NTX Pay — exibido apenas na criação. Guarde com
            segurança.
          example: whsec_abc123
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT obtido em POST /api/auth/token

````