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

# Criar Webhook

> Registra uma URL para receber notificações de eventos de pagamento.

As requisições enviadas para a URL incluem o header `x-valora-signature` com um HMAC-SHA256 do body usando o `secret` do webhook.



## OpenAPI

````yaml POST /v1/webhook
openapi: 3.1.0
info:
  title: Valora Payment Gateway
  description: >-
    Gateway de pagamentos brasileiro com suporte a PIX e cripto (USDT/USDC/EURC
    na rede Solana).


    ## Autenticação

    Todas as rotas exigem o header `x-api-key` com sua chave de API.


    ## Convenção de valores

    - **Request**: valores em **centavos** (inteiro). Ex: `5000` = R$50,00

    - **Response**: valores em **BRL** (float). Ex: `50.0` = R$50,00


    ## Formato de erro

    Todos os erros retornam `{ "error": { "code": "ERROR_CODE", "message": "..."
    } }`
  version: 1.0.0
  contact:
    name: Suporte Valora
    url: https://valorapayments.com.br
servers:
  - url: https://api.valorapayments.com.br
    description: Produção
  - url: https://sandbox.api.valorapayments.com.br
    description: Sandbox
security:
  - ApiKey: []
paths:
  /v1/webhook:
    post:
      tags:
        - Webhooks
      summary: Criar webhook
      description: >-
        Registra uma URL para receber notificações de eventos de pagamento.


        As requisições enviadas para a URL incluem o header `x-valora-signature`
        com um HMAC-SHA256 do body usando o `secret` do webhook.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreateRequest'
            example:
              url: https://meusite.com.br/webhooks/valora
              events:
                - payment.confirmed
                - payment.failed
                - payment.expired
      responses:
        '201':
          description: Webhook criado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookObject'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    WebhookCreateRequest:
      type: object
      required:
        - url
        - events
      properties:
        url:
          type: string
          format: uri
          description: URL HTTPS que receberá os eventos via POST
          example: https://meusite.com.br/webhooks/valora
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
          description: Lista de eventos a monitorar
          example:
            - payment.confirmed
            - payment.failed
    WebhookObject:
      type: object
      properties:
        webhook_id:
          type: string
          example: wh_a1b2c3d4
        business_id:
          type: string
        url:
          type: string
          format: uri
        events:
          type: array
          items:
            $ref: '#/components/schemas/WebhookEventType'
        status:
          type: string
          enum:
            - active
            - inactive
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    WebhookEventType:
      type: string
      enum:
        - payment.created
        - payment.confirmed
        - payment.expired
        - payment.failed
      description: Eventos disponíveis para assinatura
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Código de erro em SNAKE_UPPER_CASE
              example: NOT_FOUND
            message:
              type: string
              description: Descrição legível do erro
              example: Pagamento não encontrado.
  responses:
    ValidationError:
      description: Dados inválidos na requisição
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing_fields:
              value:
                error:
                  code: MISSING_FIELDS
                  message: 'Campos obrigatórios ausentes: payment_method, amount.'
            invalid_status:
              value:
                error:
                  code: INVALID_STATUS
                  message: >-
                    Não é possível realizar esta operação em pagamento com
                    status "paid".
            no_fee_rule:
              value:
                error:
                  code: NO_FEE_RULE
                  message: >-
                    Nenhuma regra de taxa configurada para este método de
                    pagamento.
            unsupported_method:
              value:
                error:
                  code: UNSUPPORTED_PAYMENT_METHOD
                  message: Método de pagamento não suportado.
    RateLimited:
      description: Limite de requisições excedido (60 req/min por API key)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Muitas requisições. Tente novamente em alguns instantes.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API gerada no painel Valora. Envie em todas as requisições.

````