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

> Lists the transactions this plugin has persisted, most recent first. Use it to reconcile your own records against the plugin's, or to find the local transaction id of an order you know only by its end-to-end id.

Read-only. Every filter is optional and they combine with AND: account_id (the CRM account id), end_to_end_id, status (the eTransactionStatus NAME, e.g. EXECUTED), and is_refund. is_refund is tri-state and parsed leniently — only "true" and "false" filter, and ANY other value (including "1" or "yes") leaves the filter unset rather than erroring, so a typo there silently widens the result set. There is no pagination and no page size: the response is the whole matching set in one array, so filter narrowly on a busy account. Amounts are integer centavos.

An unknown account_id or end_to_end_id is not an error — it matches nothing and returns an empty array, so absence here means "nothing persisted under that value", never "the value is wrong". The only refusal is 400 PIX-0061 for a status that is not a known eTransactionStatus name.

THIS FEED INCLUDES MOVEMENTS THAT BELONG TO INDIRECT PARTICIPANTS, and nothing here separates them. When this participant serves indirect participants (institutions registered with POST /v1/indirects), their credits and payments are persisted as ordinary transactions and come back mixed in with the direct participant's own. There is no filter on the institution — for one of them, `account_id` is its `@pi_{ispb}` settlement alias rather than a CRM account id, which is the practical way to isolate it here, and GET /v1/indirects/{indirectId}/transactions is the purpose-built feed (it is windowed, cursor-paged and ordered for reconciliation, which this one is not).



## OpenAPI

````yaml /en/openapi/v3-current/pix.yaml get /v1/transactions
openapi: 3.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/transactions:
    get:
      tags:
        - Transactions
      summary: List PIX transactions
      description: >-
        Lists the transactions this plugin has persisted, most recent first. Use
        it to reconcile your own records against the plugin's, or to find the
        local transaction id of an order you know only by its end-to-end id.


        Read-only. Every filter is optional and they combine with AND:
        account_id (the CRM account id), end_to_end_id, status (the
        eTransactionStatus NAME, e.g. EXECUTED), and is_refund. is_refund is
        tri-state and parsed leniently — only "true" and "false" filter, and ANY
        other value (including "1" or "yes") leaves the filter unset rather than
        erroring, so a typo there silently widens the result set. There is no
        pagination and no page size: the response is the whole matching set in
        one array, so filter narrowly on a busy account. Amounts are integer
        centavos.


        An unknown account_id or end_to_end_id is not an error — it matches
        nothing and returns an empty array, so absence here means "nothing
        persisted under that value", never "the value is wrong". The only
        refusal is 400 PIX-0061 for a status that is not a known
        eTransactionStatus name.


        THIS FEED INCLUDES MOVEMENTS THAT BELONG TO INDIRECT PARTICIPANTS, and
        nothing here separates them. When this participant serves indirect
        participants (institutions registered with POST /v1/indirects), their
        credits and payments are persisted as ordinary transactions and come
        back mixed in with the direct participant's own. There is no filter on
        the institution — for one of them, `account_id` is its `@pi_{ispb}`
        settlement alias rather than a CRM account id, which is the practical
        way to isolate it here, and GET /v1/indirects/{indirectId}/transactions
        is the purpose-built feed (it is windowed, cursor-paged and ordered for
        reconciliation, which this one is not).
      operationId: getTransactions
      parameters:
        - description: Filter by the CRM account id.
          explode: false
          in: query
          name: account_id
          schema:
            description: Filter by the CRM account id.
            examples:
              - acc-123
            type: string
        - description: Filter by the SPI end-to-end id.
          explode: false
          in: query
          name: end_to_end_id
          schema:
            description: Filter by the SPI end-to-end id.
            examples:
              - E1234567890
            type: string
        - description: Filter by eTransactionStatus name.
          explode: false
          in: query
          name: status
          schema:
            description: Filter by eTransactionStatus name.
            examples:
              - EXECUTED
            type: string
        - description: Filter by refund flag ('true'/'false').
          explode: false
          in: query
          name: is_refund
          schema:
            description: Filter by refund flag ('true'/'false').
            examples:
              - 'false'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionListBody'
          description: OK
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    TransactionListBody:
      additionalProperties: false
      properties:
        data:
          description: The list of transactions.
          items:
            $ref: '#/components/schemas/TransactionListItem'
          type:
            - array
            - 'null'
      required:
        - data
      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
    TransactionListItem:
      additionalProperties: false
      properties:
        amount:
          description: Transaction amount in centavos.
          examples:
            - 10050
          format: int64
          type: integer
        createdAt:
          description: Creation timestamp (RFC 3339 UTC).
          examples:
            - '2026-06-19T12:00:00Z'
          type: string
        description:
          description: Payment description.
          examples:
            - Invoice 42
          type: string
        endToEndId:
          description: The SPI end-to-end id.
          examples:
            - E1234567890
          type: string
        flow:
          description: Numeric eTransactionFlow.
          examples:
            - 2
          format: int64
          type: integer
        id:
          description: The transaction id.
          examples:
            - d1f9c0a2-...
          type: string
        isRefund:
          description: Whether this row is a refund.
          examples:
            - false
          type: boolean
        jdpiRequestId:
          description: The JDPI request id.
          examples:
            - REQ-123
          type: string
        payee:
          $ref: '#/components/schemas/PartyResponse'
          description: The payee party.
        payer:
          $ref: '#/components/schemas/PartyResponse'
          description: The payer party.
        priority:
          description: Numeric eTransactionPriority.
          examples:
            - 1
          format: int64
          type: integer
        status:
          description: eTransactionStatus name.
          examples:
            - EXECUTED
          type: string
        type:
          description: Numeric eTransactionType (1=PIX).
          examples:
            - 1
          format: int64
          type: integer
        updatedAt:
          description: Last-update timestamp (RFC 3339 UTC).
          examples:
            - '2026-06-19T12:00:00Z'
          type: string
      required:
        - id
        - status
        - flow
        - type
        - amount
        - priority
        - isRefund
        - 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
    PartyResponse:
      additionalProperties: false
      properties:
        accountDigit:
          description: The party's account check digit.
          examples:
            - '7'
          type: string
        accountId:
          description: The party's CRM account id.
          examples:
            - acc-123
          type: string
        accountNumber:
          description: The party's account number.
          examples:
            - '123456'
          type: string
        accountType:
          description: >-
            Numeric JDPI tpConta (0=Conta Corrente, 1=Conta Salario, 2=Conta
            Poupanca, 3=Conta de Pagamento, 4=Conta PI).
          examples:
            - 0
          format: int64
          type: integer
        branch:
          description: The party's agency/branch.
          examples:
            - '0001'
          type: string
        document:
          description: The party's document (CPF/CNPJ).
          examples:
            - '12345678909'
          type: string
        ispb:
          description: The party's participant ISPB.
          examples:
            - '12345678'
          type: string
        key:
          description: The party's PIX key.
          examples:
            - foo@bar.com
          type: string
        keyType:
          description: Numeric eKeyType.
          examples:
            - 2
          format: int64
          type: integer
        name:
          description: The party's holder name.
          examples:
            - Jane Doe
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````