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

# Listar transferencias Pix

> Usa este endpoint para listar transferencias Pix con filtros opcionales y
paginación.



## OpenAPI

````yaml es/openapi/v3-current/indirect-pix.yaml GET /v1/transfers
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - API completa
  description: |
    API completa para el sistema de pagos instantáneos Pix de Brasil, que
    incluye operaciones del diccionario de claves Pix, generación/decodificación
    de códigos QR, transacciones y límites transaccionales.
  version: 1.7.6
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/transfers:
    get:
      tags:
        - Transactions API
      summary: Listar transferencias Pix
      description: >-
        Usa este endpoint para listar transferencias Pix con filtros opcionales
        y

        paginación.
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - $ref: '#/components/parameters/SortOrder'
        - name: end_to_end
          in: query
          description: Filtra por el identificador end-to-end de la transferencia Pix.
          required: false
          example: E123456789BR1234567890123456789
          schema:
            type: string
        - name: status
          in: query
          description: >-
            Filtra por el estado de la transferencia (CREATED, PENDING,
            PROCESSING,

            COMPLETED, FAILED, REVERSED).
          required: false
          example: COMPLETED
          schema:
            type: string
            enum:
              - CREATED
              - PENDING
              - PROCESSING
              - COMPLETED
              - FAILED
              - REVERSED
        - name: type
          in: query
          description: Filtra por la dirección de la transferencia (CASHOUT o CASHIN).
          required: false
          example: CASHOUT
          schema:
            type: string
            enum:
              - CASHOUT
              - CASHIN
        - $ref: '#/components/parameters/ModifiedAfter'
        - $ref: '#/components/parameters/ModifiedBefore'
        - $ref: '#/components/parameters/XAccountId'
      responses:
        '200':
          description: Lista de transferencias Pix recuperada correctamente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransfersListOutput'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
                ErrorPIX0009:
                  $ref: '#/components/examples/ErrorPIX0009'
                ErrorPIX0010:
                  $ref: '#/components/examples/ErrorPIX0010'
                ErrorPIX0011:
                  $ref: '#/components/examples/ErrorPIX0011'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0000:
                  $ref: '#/components/examples/ErrorPIX0000'
      deprecated: false
      security:
        - bearerAuth: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Número máximo de elementos por página.
      required: false
      example: 10
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 10
    Offset:
      name: offset
      in: query
      description: >-
        Número de elementos que se omiten antes de comenzar a recopilar el
        conjunto de resultados.
      required: false
      example: 0
      schema:
        type: integer
        default: 0
    SortOrder:
      name: sort_order
      in: query
      description: 'Dirección de ordenamiento: asc o desc.'
      required: false
      example: asc
      schema:
        type: string
        enum:
          - asc
          - desc
        default: asc
    ModifiedAfter:
      name: modified_after
      in: query
      description: >-
        Filtra por registros modificados después de esta marca de tiempo
        (formato RFC3339: 2024-01-15T10:30:00Z).
      required: false
      schema:
        type: string
    ModifiedBefore:
      name: modified_before
      in: query
      description: >-
        Filtra por registros modificados antes de esta marca de tiempo (formato
        RFC3339: 2024-01-15T10:30:00Z).
      required: false
      schema:
        type: string
    XAccountId:
      name: X-Account-Id
      in: header
      description: Identificador único de la cuenta del Ledger de Midaz (formato UUID).
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    TransfersListOutput:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TransferObject'
        limit:
          type: integer
          example: 10
        offset:
          type: integer
          example: 0
    ErrorFormat:
      type: object
      description: El mensaje de error de la respuesta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Un identificador único y estable para el error.
        title:
          type: string
          description: Un breve resumen del problema.
        message:
          type: string
          description: Orientación detallada para resolver el error.
    TransferObject:
      type: object
      properties:
        id:
          type: string
          description: Identificador único de la transferencia.
          example: 019c96a0-0c21-71f9-a487-66a1258278a1
        endToEndId:
          type: string
          description: Identificador de extremo a extremo.
          example: E123456789BR1234567890123456789
        amount:
          type: string
          description: Monto de la transferencia en BRL (formato `0.00`).
          example: '100.00'
        status:
          type: string
          description: Estado de la transferencia.
          enum:
            - CREATED
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
            - REVERSED
          example: COMPLETED
        type:
          type: string
          description: Tipo de transferencia.
          enum:
            - CASHOUT
            - CASHIN
          example: CASHOUT
        description:
          type: string
          maxLength: 140
          description: Descripción o mensaje opcional.
          example: Pix Cashout Transfer
        source:
          $ref: '#/components/schemas/TransferPartyObject'
        destination:
          $ref: '#/components/schemas/TransferPartyObject'
        paymentType:
          type: string
          description: Tipo de pago.
          enum:
            - IMMEDIATE
            - SCHEDULED
          example: IMMEDIATE
        initiationType:
          type: string
          description: Tipo de iniciación.
          enum:
            - MANUAL
            - KEY
            - QR_CODE
          example: KEY
        urgency:
          type: string
          description: Urgencia de la transferencia.
          enum:
            - HIGH
            - NORMAL
          example: HIGH
        purpose:
          type: string
          description: >-
            Tipo de finalidad de la transacción. El valor predeterminado es
            TRANSFER.
          enum:
            - TRANSFER
            - INSTANT_PAYMENT_REFUND
          example: TRANSFER
        accountId:
          type: string
          description: Identificador de la cuenta (UUID).
          example: 01989f9e-6508-79f8-9540-835be49fbd0d
        aliasId:
          type: string
          description: Identificador del alias (UUID).
          example: 01989f9e-6508-79f8-9540-835be49fbd0e
        initiatedAt:
          type: string
          format: date-time
          description: Marca de tiempo de la iniciación (ISO 8601 UTC).
          example: '2024-01-15T10:30:00Z'
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        ledger:
          $ref: '#/components/schemas/LedgerInfoObject'
        metadata:
          type: object
          additionalProperties: true
          description: >-
            Atributos personalizados de clave-valor asociados con esta
            transferencia.

            Máximo 50 claves, clave de máximo 100 caracteres, valor de máximo
            2000 caracteres.
        feeCharge:
          $ref: '#/components/schemas/FeeChargeObject'
    TransferPartyObject:
      type: object
      description: Información de la parte de la cuenta (origen o destino).
      properties:
        key:
          type: string
          description: Clave Pix (si corresponde).
          example: john.doe@example.com
        account:
          type: object
          description: Detalles de la cuenta.
          properties:
            branch:
              type: string
              description: Código de la agencia bancaria.
              example: '0001'
            number:
              type: string
              description: Número de cuenta.
              example: '123456789'
            participant:
              type: string
              description: ISPB de la institución participante (8 dígitos).
              example: '12345678'
            type:
              type: string
              description: Tipo de cuenta.
              enum:
                - CACC
                - SVGS
                - TRAN
                - OTHR
              example: CACC
        owner:
          type: object
          description: Detalles del titular.
          properties:
            document:
              type: string
              description: Documento de identificación (CPF 11 dígitos o CNPJ 14 dígitos).
              example: '12345678901'
            name:
              type: string
              description: Nombre completo o razón social.
              example: John Doe
            tradeName:
              type: string
              description: Nombre comercial (opcional).
              example: John's Business
            type:
              type: string
              enum:
                - NATURAL_PERSON
                - LEGAL_PERSON
              description: Tipo de titular.
              example: NATURAL_PERSON
    LedgerInfoObject:
      type: object
      description: Identificadores de transacción y operación del ledger de Midaz.
      properties:
        transactionId:
          type: string
          description: Identificador de la transacción de Midaz (UUID).
          example: 550e8400-e29b-41d4-a716-446655440011
        sourceOperationId:
          type: string
          description: Identificador de la operación de origen (DEBIT) de Midaz (UUID).
          example: 550e8400-e29b-41d4-a716-446655440012
        destinationOperationId:
          type: string
          description: Identificador de la operación de destino (CREDIT) de Midaz (UUID).
          example: 550e8400-e29b-41d4-a716-446655440013
        revert:
          type: object
          description: >-
            Detalles de la transacción de reversión (presente solo cuando se
            rechaza y se revierte).
          properties:
            transactionId:
              type: string
              description: Identificador de la transacción de reversión de Midaz (UUID).
              example: 550e8400-e29b-41d4-a716-446655440014
            sourceOperationId:
              type: string
              description: >-
                Identificador de la operación de origen de reversión (DEBIT) de
                Midaz (UUID).
              example: 550e8400-e29b-41d4-a716-446655440015
            destinationOperationId:
              type: string
              description: >-
                Identificador de la operación de destino de reversión (CREDIT)
                de Midaz (UUID).
              example: 550e8400-e29b-41d4-a716-446655440016
    FeeChargeObject:
      type: object
      description: Detalles del cálculo de tarifas (si corresponde).
      properties:
        applied:
          type: boolean
          description: Indica si se aplicaron tarifas.
          example: true
        calculationType:
          type: string
          description: Tipo de cálculo de la tarifa.
          example: segment
        totalAmount:
          type: string
          description: Monto total de la tarifa.
          example: '2.50'
        netAmount:
          type: string
          description: Monto neto después de las tarifas.
          example: '97.50'
        fees:
          type: array
          description: Lista de tarifas individuales aplicadas.
          items:
            type: object
            properties:
              feeLabel:
                type: string
                description: Etiqueta/nombre de la tarifa.
                example: PIX_FEE
              amount:
                type: string
                description: Monto de la tarifa.
                example: '1.50'
              creditAccount:
                type: string
                description: Cuenta que recibe la tarifa.
                example: 01989f9e-6508-79f8-9540-835be49fbd0d
              calculationType:
                type: string
                description: Cómo se calculó la tarifa.
                example: PERCENTAGE
              calculationValue:
                type: string
                description: El parámetro de cálculo (porcentaje o valor fijo).
                example: '1.5'
  examples:
    ErrorPIX0001:
      summary: Missing Headers in Request
      value:
        code: PIX-0001
        title: Missing Headers in Request
        message: >-
          Your request is missing one or more required header params. Please
          refer to the documentation to ensure all necessary header params are
          included in your request.
    ErrorPIX0009:
      summary: Missing Query Params in Request
      value:
        code: PIX-0009
        title: Missing Query Params in Request
        message: >-
          Your request is missing one or more required query params. Please
          refer to the documentation to ensure all necessary query params are
          included in your request.
    ErrorPIX0010:
      summary: Invalid Query Param in Request
      value:
        code: PIX-0010
        title: Invalid Query Param in Request
        message: >-
          One or more query params are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each query param.
    ErrorPIX0011:
      summary: Invalid Timestamp Format
      value:
        code: PIX-0011
        title: Invalid Timestamp Format
        message: >-
          The timestamp format is invalid. Please refer to the documentation to
          verify the expected format.
    ErrorPIX0000:
      summary: Internal Server Error
      value:
        code: PIX-0000
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````