> ## 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 Pix refunds for an account

> Returns a cursor-paginated page of refunds for the calling account.



## OpenAPI

````yaml en/openapi/v3-current/pix-lerian-spi.yaml GET /refunds
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: Public API for outbound Pix transfers and refunds.
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
  title: Pix Lerian — Payments
  version: release-candidate
servers:
  - url: https://api.example.com/spi/v1
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
tags:
  - description: Initiate, process, list, and retrieve outbound Pix transfers.
    name: Transfers
  - description: Create, list, and retrieve Pix refunds.
    name: Refunds
paths:
  /refunds:
    get:
      tags:
        - Refunds
      summary: List Pix refunds for an account
      description: Returns a cursor-paginated page of refunds for the calling account.
      operationId: listRefunds
      parameters:
        - description: UUID of the account associated with the operation.
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: UUID of the account associated with the operation.
            examples:
              - 019606a1-3b4c-7d8e-9f01-234567890abc
            type: string
          example: 019606a1-3b4c-7d8e-9f01-234567890abc
        - description: Filter by original transfer UUID
          explode: false
          in: query
          name: transferId
          schema:
            description: Filter by original transfer UUID
            type: string
          example: 019606a1-3b4c-7d8e-9f01-234567890abc
        - description: Filter by refund status (lowercase)
          explode: false
          in: query
          name: status
          schema:
            description: Filter by refund status (lowercase)
            examples:
              - completed
            type: string
          example: completed
        - description: Filter by direction (lowercase)
          explode: false
          in: query
          name: direction
          schema:
            description: Filter by direction (lowercase)
            examples:
              - out
            type: string
          example: out
        - description: Opaque cursor returned by the previous page
          explode: false
          in: query
          name: after
          schema:
            description: Opaque cursor returned by the previous page
            type: string
          example: after-example
        - description: Page size (1-100, default 20)
          explode: false
          in: query
          name: limit
          schema:
            description: Page size (1-100, default 20)
            examples:
              - '20'
            type: string
          example: '20'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundsListOutput'
              examples:
                fictitiousExample:
                  summary: Fictitious example
                  value:
                    items:
                      - accountId: 019606a0-1a2b-7c3d-8e4f-567890123abc
                        amount: '100.00'
                        createdAt: '2026-05-06T10:45:00Z'
                        description: Estorno solicitado pelo pagador
                        id: 019606b1-3b4c-7d8e-9f01-234567890dee
                        ledger:
                          destinationOperationId: 019606a5-7f80-7182-3c4d-56789012cdf1
                          revert:
                            destinationOperationId: 019606a5-7f80-7182-3c4d-56789012cdf1
                            sourceOperationId: 019606a5-7f80-7182-3c4d-56789012cdf0
                            transactionId: 019606a5-7f80-7182-3c4d-56789012cdef
                          sourceOperationId: 019606a5-7f80-7182-3c4d-56789012cdf0
                          transactionId: 019606a5-7f80-7182-3c4d-56789012cdef
                        metadata:
                          field: field-example
                        originalEndToEndId: E12345678202605061030abcdef12345
                        reasonCode: MD06
                        returnEndToEndId: D12345678202605061045fedcba54321
                        status: COMPLETED
                        type: OUTBOUND
                        updatedAt: '2026-05-06T10:45:30Z'
                    next_cursor: >-
                      eyJpZCI6IjAxOTYwNmIxLTNiNGMtN2Q4ZS05ZjAxLTIzNDU2Nzg5MGRlZSJ9
                    prev_cursor: >-
                      eyJpZCI6IjAxOTYwNmIxLTNiNGMtN2Q4ZS05ZjAxLTIzNDU2Nzg5MGRlZSJ9
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      x-codeSamples:
        - lang: bash
          label: cURL with fictitious data
          source: |-
            curl --request GET \
              --url https://api.example.com/spi/v1/refunds \
              --header 'Authorization: Bearer demo-access-token' \
              --header 'X-Account-Id: 019606a1-3b4c-7d8e-9f01-234567890abc'
components:
  schemas:
    RefundsListOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/RefundCashoutOutput'
          type:
            - array
            - 'null'
        next_cursor:
          examples:
            - eyJpZCI6IjAxOTYwNmIxLTNiNGMtN2Q4ZS05ZjAxLTIzNDU2Nzg5MGRlZSJ9
          type: string
        prev_cursor:
          examples:
            - eyJpZCI6IjAxOTYwNmIxLTNiNGMtN2Q4ZS05ZjAxLTIzNDU2Nzg5MGRlZSJ9
          type: string
      required:
        - items
      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
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    RefundCashoutOutput:
      additionalProperties: false
      properties:
        accountId:
          examples:
            - 019606a0-1a2b-7c3d-8e4f-567890123abc
          type: string
        amount:
          examples:
            - '100.00'
          type: string
        createdAt:
          examples:
            - '2026-05-06T10:45:00Z'
          format: date-time
          type: string
        deletedAt:
          format: date-time
          type: string
        description:
          examples:
            - Estorno solicitado pelo pagador
          type: string
        id:
          examples:
            - 019606b1-3b4c-7d8e-9f01-234567890dee
          type: string
        ledger:
          $ref: '#/components/schemas/LedgerInfo'
        metadata:
          additionalProperties: {}
          type: object
        originalEndToEndId:
          examples:
            - E12345678202605061030abcdef12345
          type: string
        reasonCode:
          examples:
            - MD06
          type: string
        returnEndToEndId:
          examples:
            - D12345678202605061045fedcba54321
          type: string
        status:
          examples:
            - COMPLETED
          type: string
        type:
          examples:
            - OUTBOUND
          type: string
        updatedAt:
          examples:
            - '2026-05-06T10:45:30Z'
          format: date-time
          type: string
      required:
        - id
        - originalEndToEndId
        - status
        - type
        - amount
        - reasonCode
        - 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
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
    LedgerInfo:
      additionalProperties: false
      properties:
        destinationOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf1
          type: string
        revert:
          $ref: '#/components/schemas/LedgerRevertInfo'
        sourceOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf0
          type: string
        transactionId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdef
          type: string
      type: object
    LedgerRevertInfo:
      additionalProperties: false
      properties:
        destinationOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf1
          type: string
        sourceOperationId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdf0
          type: string
        transactionId:
          examples:
            - 019606a5-7f80-7182-3c4d-56789012cdef
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````