> ## 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.

# List DICT refunds

> Returns paginated local DICT refund records.



## OpenAPI

````yaml en/openapi/v3-current/spi-dict.yaml get /api/v1/dict/refunds
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    OpenAPI 3.1 surface for the DICT (Diretório de Identificadores de Contas
    Transacionais) capability of Lerian SPI, the direct integration between the
    institution and the Brazilian Instant Payment System (SPI/Pix). It covers
    the PIX key lifecycle, portability and ownership claims, infraction reports,
    refunds, fraud markers, synchronous DICT reports, and the internal
    reconciliation and provisioning operations that keep the key directory
    consistent.
  license:
    name: Lerian Studio General License
  title: Lerian SPI — DICT API
  version: 1.0.0
servers:
  - url: https://spi.sandbox.lerian.net
security: []
tags:
  - description: 'PIX key lifecycle: register, list, search, lookup, delete, and statistics.'
    name: Keys
  - description: >-
      PIX key portability and ownership claims through their full lifecycle
      (initiate, confirm, reject, cancel, acknowledge, complete).
    name: Claims
  - description: 'DICT infraction reports: create, list, and retrieve.'
    name: Infractions
  - description: 'DICT refund requests: create, list, and retrieve.'
    name: Refunds
  - description: 'PIX fraud markers: create, list, and statistics.'
    name: Fraud Markers
  - description: >-
      Synchronous reports over Lerian SPI's own DICT record: COUNT(*) summaries
      of keys (by type/status) and claims (by type/status + open-past-deadline).
      COUNT-only — DICT holds no money.
    name: Reports
  - description: >-
      Internal DICT operations: reconciliation runs, participant ISPB
      provisioning, claim deadline processing, and orphaned-key cleanup.
    name: Internal
paths:
  /api/v1/dict/refunds:
    get:
      tags:
        - Refunds
      summary: List DICT refunds
      description: Returns paginated local DICT refund records.
      operationId: listRefunds
      parameters:
        - description: Page size (default 25, max 100)
          explode: false
          in: query
          name: limit
          schema:
            default: 25
            description: Page size (default 25, max 100)
            format: int64
            maximum: 100
            minimum: 1
            type: integer
        - description: Page offset (default 0)
          explode: false
          in: query
          name: offset
          schema:
            default: 0
            description: Page offset (default 0)
            format: int64
            minimum: 0
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundListResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    RefundListResponse:
      additionalProperties: false
      properties:
        correlationId:
          description: >-
            Request-scoped correlation identifier echoing X-Request-ID, for
            pivoting from response to trace.
          type: string
        items:
          description: >-
            Local DICT refund request records for the requested limit/offset
            window.
          items:
            $ref: '#/components/schemas/RefundResponse'
          type:
            - array
            - 'null'
        limit:
          description: Effective page size applied to this response.
          format: int64
          type: integer
        offset:
          description: Zero-based offset of the first item in this page.
          format: int64
          type: integer
      required:
        - items
        - limit
        - offset
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    RefundResponse:
      additionalProperties: false
      properties:
        amountCents:
          description: Refund amount in integer minor units (BRL centavos)
          examples:
            - 150000
          format: int64
          type: integer
        createdAt:
          description: Record creation timestamp (RFC 3339, UTC)
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
        effectiveRefundedAmountCents:
          description: >-
            MED 2.0: effective refunded amount in cents recorded on an accepting
            close (verbatim); omitted until close
          examples:
            - 75000
          format: int64
          type: integer
        endToEndId:
          description: BACEN end-to-end identifier (E2E ID) of the refunded PIX transaction
          examples:
            - E1234567820260614ABCDEFGHIJKLMNO
          type: string
        fundsRecoveryId:
          description: >-
            Local funds-recovery id this refund is bound to
            (refund-under-recovery); omitted for a standalone refund
          examples:
            - 550e8400-e29b-41d4-a716-446655440003
          type: string
        id:
          description: Server-assigned refund record UUID
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
        monitorAccount:
          description: 'MED 2.0: whether the destination account is monitored'
          examples:
            - true
          type: boolean
        reason:
          description: Free-text justification for the refund request
          type: string
        refundAccount:
          $ref: '#/components/schemas/RefundAccountResponse'
          description: >-
            MED 2.0: destination account of a refund-under-recovery; omitted for
            a standalone refund
        reportStatus:
          description: >-
            BACEN report delivery state: PENDING, SENT, or FAILED (FAILED is
            retryable; the local record stands)
          examples:
            - SENT
          type: string
        requestedByISPB:
          description: ISPB (8 numeric digits) of the participant that requested the refund
          examples:
            - '12345678'
          type: string
        status:
          description: >-
            Local refund lifecycle state: REQUESTED, ACCEPTED, REJECTED,
            SETTLED, or CANCELLED
          examples:
            - REQUESTED
          type: string
        updatedAt:
          description: Last update timestamp (RFC 3339, UTC)
          examples:
            - '2026-06-14T12:00:00Z'
          type: string
      required:
        - id
        - endToEndId
        - requestedByISPB
        - amountCents
        - reason
        - status
        - reportStatus
        - createdAt
        - updatedAt
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    RefundAccountResponse:
      additionalProperties: false
      properties:
        accountNumber:
          description: Destination account number
          examples:
            - '987654'
          type: string
        accountType:
          description: 'ISO 20022 account type: CACC, SVGS, TRAN, SLRY, or OTHR'
          examples:
            - CACC
          type: string
        branch:
          description: Destination account branch (optional)
          examples:
            - '0001'
          type: string
        participant:
          description: Destination account-holding participant ISPB
          examples:
            - '12345678'
          type: string
        taxIdNumber:
          description: Destination account holder tax id (CPF/CNPJ)
          examples:
            - '12345678909'
          type: string
      required:
        - taxIdNumber
        - participant
        - accountNumber
        - accountType
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````