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

# Retrieve notification delivery

> Returns the body sent and the endpoint's response for each delivery attempt.



## OpenAPI

````yaml /openapi.yaml get /webhook-deliveries/{deliveryId}
openapi: 3.0.3
info:
  title: Fincle API
  version: 1.0.0
  description: >-
    Fincle payments API: charges by Pix, credit card and boleto, subscriptions,
    transactions, refunds, infractions, notifications and transfers.
servers:
  - url: https://api.fincle.com.br
    description: Production server
security: []
tags:
  - name: Authentication
    description: Issuance of the access token from the API key.
  - name: Charges
    description: Creation of charges by Pix, credit card and boleto.
  - name: Subscriptions
    description: Recurring billing on credit card.
  - name: Transactions
    description: Retrieval and refund of transactions.
  - name: Refunds
    description: Refund requests submitted by payers.
  - name: Infractions and MED
    description: Pix infraction reports and the amounts blocked as a result.
  - name: Webhooks
    description: Registration of notification endpoints and tracking of deliveries.
  - name: Balance and transfers
    description: Balance, statement, fees and transfer of the amounts received.
paths:
  /webhook-deliveries/{deliveryId}:
    get:
      tags:
        - Webhooks
      summary: Retrieve notification delivery
      description: >-
        Returns the body sent and the endpoint's response for each delivery
        attempt.
      operationId: getWebhookDelivery
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: deliveryId
          required: true
          description: Delivery identifier.
      responses:
        '200':
          description: Delivery found, with payload and attempts.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `true` in a successful response.
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Delivery identifier.
                      transactionId:
                        type: string
                        nullable: true
                        description: >-
                          Transaction that gave rise to the event, when
                          applicable.
                      type:
                        type: string
                        enum:
                          - transaction
                          - transfer
                          - infraction
                        description: >-
                          Source of the event: transaction, transfer or
                          infraction.
                      event:
                        type: string
                        enum:
                          - transaction_created
                          - transaction_paid
                          - transaction_refunded
                          - transaction_updated
                          - transfer_completed
                          - transfer_canceled
                          - transfer_created
                          - transfer_updated
                          - infraction
                          - cart_abandoned
                          - sale_lost
                          - card_declined
                          - product_canceled
                          - company_approved
                          - product_approved
                          - product_refused
                          - withdrawal_requested
                          - withdrawal_sent
                          - transaction_reversal
                          - release_access
                          - vturb_paid
                          - vk_metrics_purchase
                          - refund_requested
                        description: Notified event.
                      eventType:
                        type: string
                        description: Label of the event as sent in the notification body.
                      status:
                        type: string
                        enum:
                          - pending
                          - success
                          - error
                          - failed
                          - suppressed
                        description: >-
                          Delivery status: pending, delivered, failed or
                          suppressed.
                      url:
                        type: string
                        description: URL that received (or will receive) the POST.
                      retries:
                        type: integer
                        description: Number of retries already made.
                      createdAt:
                        type: string
                        format: date-time
                        description: Time at which the event was queued.
                      updatedAt:
                        type: string
                        format: date-time
                        description: Time of the last attempt.
                      payload:
                        description: >-
                          JSON body exactly as sent to the integrator's
                          endpoint.
                      attempts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Attempt identifier.
                            httpStatus:
                              type: integer
                              description: >-
                                HTTP status returned by the integrator's server
                                in this attempt.
                            response:
                              description: >-
                                Response body received, as returned by the
                                integrator's server.
                            attemptedAt:
                              type: string
                              format: date-time
                              description: Time of this attempt.
                          required:
                            - id
                            - httpStatus
                            - attemptedAt
                          additionalProperties: false
                        description: Attempts already made, from oldest to newest.
                    required:
                      - id
                      - transactionId
                      - type
                      - event
                      - eventType
                      - status
                      - url
                      - retries
                      - createdAt
                      - updatedAt
                      - attempts
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Delivery found, with payload and attempts.
              example:
                success: true
                data:
                  id: clx9f1m2p0004qz0a7h8i9j0k
                  transactionId: clx9e0k1n0002qz0a5f6g7h8i
                  type: transaction
                  event: transaction_paid
                  eventType: transaction.paid
                  status: error
                  url: https://api.example.com/webhooks/fincle
                  retries: 3
                  createdAt: '2026-09-10T14:22:05.000Z'
                  updatedAt: '2026-09-10T14:38:41.000Z'
                  payload:
                    event: transaction.paid
                    data:
                      id: clx9e0k1n0002qz0a5f6g7h8i
                      amount: 49900
                      status: paid
                      paymentMethod: pix
                      customer:
                        name: Helena Martins Andrade
                        document: 318.457.920-41
                        email: helena.andrade@example.com
                  attempts:
                    - id: 90114
                      httpStatus: 500
                      response:
                        error: internal server error
                      attemptedAt: '2026-09-10T14:22:07.000Z'
                    - id: 90118
                      httpStatus: 502
                      response: Bad Gateway
                      attemptedAt: '2026-09-10T14:38:41.000Z'
        '401':
          description: Token missing, invalid, expired or belonging to a blocked account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Token missing, invalid, expired or belonging to a blocked
                  account.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: >-
            The resource does not exist, was deleted or belongs to another
            account.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  The resource does not exist, was deleted or belongs to another
                  account.
              example:
                success: false
                message: Recurso não encontrado
        '422':
          description: The request did not pass schema validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: The request did not pass schema validation.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Too many requests: the limit is 1000 requests per minute per source
            IP. Wait the number of seconds given in the `retry-after` header and
            retry with exponential backoff.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Too many requests: the limit is 1000 requests per minute per
                  source IP. Wait the number of seconds given in the
                  `retry-after` header and retry with exponential backoff.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Internal failure while processing the request. Retry; if it
            persists, open a support ticket stating the time and the route.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always `false` in an error response.
                  message:
                    type: string
                    description: Readable message explaining the failure.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Internal failure while processing the request. Retry; if it
                  persists, open a support ticket stating the time and the
                  route.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Seconds to wait before repeating the request.
      schema:
        type: integer
    x-ratelimit-limit:
      description: >-
        Maximum number of requests in the window (1000). Present in every
        response.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Number of requests still available in the current window. Present in
        every response.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Seconds until the window counter resets. Present in every response.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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