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

# Receber o webhook do provedor

> Recebe e persiste um evento de webhook do provedor de pagamentos. Utiliza o próprio token Bearer do provedor para a autenticação.



## OpenAPI

````yaml pt/openapi/v3-current/payments.yaml post /v1/webhooks/btg
openapi: 3.0.3
info:
  title: Payments — via BTG API
  description: >-
    API da interface de Pagamentos da Lerian via BTG. Cobre a emissão,
    cancelamento, parcelas e consultas de boletos; o pagamento de contas
    (boleto, concessionárias e DARF), seu cancelamento e consultas; painéis
    agregados de boletos e pagamentos; a conexão do provedor e a configuração de
    webhooks de saída; e o receptor de webhooks do provedor para eventos de
    liquidação.
  version: v1.0.0
servers:
  - url: https://payments.sandbox.lerian.net
security: []
tags:
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Boletos
    description: Emissão, cancelamento, parcelas e consultas de boletos
  - name: Payments
    description: >-
      Pagamentos de contas (boleto, concessionárias, DARF), cancelamento e
      consultas
  - name: Dashboards
    description: Métricas agregadas e painéis de boletos e pagamentos
  - name: Admin
    description: Endpoints administrativos para configuração de webhooks
  - name: Webhooks
    description: Receptor de webhooks do provedor para eventos de liquidação
paths:
  /v1/webhooks/btg:
    post:
      tags:
        - Webhooks
      summary: Receber o webhook do provedor
      description: >-
        Recebe e persiste um evento de webhook do provedor de pagamentos.
        Utiliza o próprio token Bearer do provedor para a autenticação.
      parameters:
        - description: Provider Bearer token
          in: header
          name: Authorization
          required: true
          schema:
            type: string
        - description: Correlation ID for tracing
          in: header
          name: X-Correlation-Id
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/http.webhookPayload'
        description: Webhook event payload
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.webhookErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.webhookErrorResponse'
        '413':
          description: Request Entity Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.webhookErrorResponse'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.webhookErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/http.webhookErrorResponse'
components:
  schemas:
    http.webhookPayload:
      properties:
        event:
          type: string
        webhookId:
          type: string
      type: object
    http.webhookErrorResponse:
      properties:
        error:
          example: Unauthorized
          type: string
      type: object

````