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

# List Recurrences

> List recurrences with parameters



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/in/pix/recurrences
openapi: 3.0.0
info:
  title: Trio API v2
  version: 2026-10-19.v2
servers:
  - url: https://api.sandbox.trio.com.br
    variables: {}
  - url: https://api.qa.trio.com.br
    variables: {}
  - url: https://api.trio.com.br
    variables: {}
security: []
tags: []
paths:
  /v2/in/pix/recurrences:
    parameters:
      - description: >-
          Version of the v2 contract the client is written against. Each
          breaking change publishes a new version.
        example: 2026-10-19.v2
        in: header
        name: Trio-Version
        required: true
        schema:
          enum:
            - 2026-10-19.v2
          type: string
          x-struct: null
          x-validate: null
      - description: >-
          ID of another org to act on instead of the API key's own org. The
          key's org must have been granted access to it, and the request is
          refused with 403 FORBIDDEN otherwise. When that access or the API key
          is read-only, only GET and HEAD requests may carry it. When the target
          org requires mTLS, so does the request. Leave it out to act on the
          key's own org.
        in: header
        name: Trio-Target-Org-Id
        required: false
        schema:
          format: uuid
          type: string
          x-struct: null
          x-validate: null
    get:
      tags:
        - Receivables (in)
        - Recurrences
      summary: List recurrences
      description: List recurrences with parameters
      operationId: TrioFoundationWeb.V2.In.Pix.RecurrenceController.index
      parameters:
        - description: Recurrence Entity Id
          in: query
          name: entity_id
          required: false
          schema:
            format: uuid
            type: string
            x-struct: null
            x-validate: null
        - description: Bank Account Id
          in: query
          name: bank_account_id
          required: false
          schema:
            format: uuid
            type: string
            x-struct: null
            x-validate: null
        - description: Recurrence datetime, lower bound for the list of recurrences
          in: query
          name: from_datetime
          required: true
          schema:
            format: date-time
            type: string
            x-struct: null
            x-validate: null
        - description: Recurrence datetime, upper bound for the list of recurrences
          in: query
          name: to_datetime
          required: true
          schema:
            format: date-time
            type: string
            x-struct: null
            x-validate: null
        - description: >-
            Parameter used for pagination. It is a base64 encoded param used to
            access the previous page of results. It is provided alongside a
            metadata section if there is a previous page.
          example: >-
            g3QAAAABZAACaWRtAAAAJDU4ZjFlYzhlLWFmYTktNDk0My05M2I1LWQ2ZGM3OWI0M2VhYQ==
          in: query
          name: before
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: >-
            Parameter used for pagination. It's a base64 encoded param used to
            access the previous page of results. Provided along with the data in
            the metadata section if there is a previous page.
          example: >-
            g3QAAAABZAACaWRtAAAAJGJhYTNiNmM1LTAyYTYtNGQ5Ny05NzU1LTI3OGFiNjRiN2Y1MQ==
          in: query
          name: after
          required: false
          schema:
            type: string
            x-struct: null
            x-validate: null
        - description: Number of registries to be returned
          in: query
          name: limit
          required: false
          schema:
            $ref: '#/components/schemas/Limit'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_RecurrenceListResponse'
          description: Recurrences
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Malformed request: a body that is not valid JSON
            (MALFORMED_REQUEST), or a Trio-Version header that is missing or not
            the current one (INVALID_TRIO_VERSION).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: Missing or invalid API key credentials (INVALID_CREDENTIALS).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            The API key may not do this (FORBIDDEN): for instance
            Trio-Target-Org-Id names an org it has no access to, or writes
            through a read-only access.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of
            the rule the request breaks). A request outside the operation's
            schema lists the offending fields in `errors`.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: >-
            A service needed to answer is unavailable
            (TRIO_SERVICE_UNAVAILABLE).
      callbacks: {}
      security:
        - authorization: []
components:
  schemas:
    Limit:
      description: Limit list
      minimum: 10
      title: Limit
      type: integer
      x-struct: null
      x-validate: null
    V2_RecurrenceListResponse:
      description: Recurrence lists response
      example:
        data:
          - amounts:
              fixed:
                amount: 10000
                currency: BRL
              maximum: null
              minimum: null
            authorized_at: null
            bank_account_id: 019f4198-8913-1ec9-52c6-706c618a1c5d
            contract_number: '0001'
            counterparty:
              bank_account:
                id: 49521ece-9203-07f7-7767-e32734e5b636
              id: 49521ece-9203-186b-cfc7-281c207f7f52
            description: Test Recurrence
            end_date: null
            external_id: null
            first_payment:
              amount: null
              date: '2026-07-10'
            id: 019f4198-9f53-8f20-a167-5242b634311d
            inserted_at: '2026-07-08T11:59:09.140530Z'
            number_of_collections: null
            options:
              automatic_schedule: true
              next_working_day: true
              retry_policy: none
            origin:
              id: 019f4198-9de7-4ba7-d718-5e9fce7cbccb
              type: api_client
            periodicity: week
            reference:
              id: null
              type: qrdn
            start_date: '2026-07-08'
            status: created
            type: in
            updated_at: '2026-07-08T11:59:09.140530Z'
        metadata:
          after: null
          before: null
          has_more: false
      properties:
        data:
          $ref: '#/components/schemas/V2_RecurrenceListData'
        metadata:
          description: Pagination cursors
          properties:
            after:
              description: Cursor to the next page
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            before:
              description: Cursor to the previous page
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            has_more:
              description: Whether a next page exists
              type: boolean
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
      title: V2 RecurrenceListResponse
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.ListResponse
      x-validate: null
    V2_error:
      example:
        error:
          error_code: INVALID_PARAMETER
          error_message: 'Invalid parameters: /amount: Invalid integer. Got: string'
          errors:
            - field: /amount
              message: 'Invalid integer. Got: string'
      properties:
        error:
          properties:
            error_code:
              description: >-
                Stable UPPER_SNAKE identifier of the error, for programs and
                logs. Branch on this, not on the message.
              type: string
              x-struct: null
              x-validate: null
            error_message:
              description: Human readable explanation of the error.
              type: string
              x-struct: null
              x-validate: null
            errors:
              description: >-
                Only on INVALID_PARAMETER for a request outside the operation's
                schema: one entry per offending field.
              items:
                properties:
                  field:
                    description: JSON pointer to the field, e.g. /amount.
                    type: string
                    x-struct: null
                    x-validate: null
                  message:
                    description: What is wrong with it.
                    type: string
                    x-struct: null
                    x-validate: null
                required:
                  - field
                  - message
                type: object
                x-struct: null
                x-validate: null
              type: array
              x-struct: null
              x-validate: null
          required:
            - error_code
            - error_message
          type: object
          x-struct: null
          x-validate: null
      required:
        - error
      title: V2 error
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error
      x-validate: null
    V2_RecurrenceListData:
      description: A list data of automatic recurrences
      example:
        - amounts:
            fixed:
              amount: 10000
              currency: BRL
            maximum: null
            minimum: null
          authorized_at: null
          bank_account_id: 019f4198-8913-1ec9-52c6-706c618a1c5d
          contract_number: '0001'
          counterparty:
            bank_account:
              id: 49521ece-9203-07f7-7767-e32734e5b636
            id: 49521ece-9203-186b-cfc7-281c207f7f52
          description: Test Recurrence
          end_date: null
          external_id: null
          first_payment:
            amount: null
            date: '2026-07-10'
          id: 019f4198-9f53-8f20-a167-5242b634311d
          inserted_at: '2026-07-08T11:59:09.140530Z'
          number_of_collections: null
          options:
            automatic_schedule: true
            next_working_day: true
            retry_policy: none
          origin:
            id: 019f4198-9de7-4ba7-d718-5e9fce7cbccb
            type: api_client
          periodicity: week
          reference:
            id: null
            type: qrdn
          start_date: '2026-07-08'
          status: created
          type: in
          updated_at: '2026-07-08T11:59:09.140530Z'
      items:
        $ref: '#/components/schemas/V2_RecurrenceData'
      title: V2 RecurrenceListData
      type: array
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.ListData
      x-validate: null
    V2_RecurrenceData:
      description: A recurrence, grouped like the request that generates it
      example:
        amounts:
          fixed:
            amount: 10000
            currency: BRL
          maximum: null
          minimum: null
        authorized_at: null
        bank_account_id: 019f4198-8913-1ec9-52c6-706c618a1c5d
        contract_number: '0001'
        counterparty:
          bank_account:
            id: 49521ece-9203-07f7-7767-e32734e5b636
          id: 49521ece-9203-186b-cfc7-281c207f7f52
        description: Test Recurrence
        end_date: null
        external_id: null
        first_payment:
          amount: null
          date: '2026-07-10'
        id: 019f4198-9f53-8f20-a167-5242b634311d
        inserted_at: '2026-07-08T11:59:09.140530Z'
        number_of_collections: null
        options:
          automatic_schedule: true
          next_working_day: true
          retry_policy: none
        origin:
          id: 019f4198-9de7-4ba7-d718-5e9fce7cbccb
          type: api_client
        periodicity: week
        reference:
          id: null
          type: qrdn
        start_date: '2026-07-08'
        status: created
        type: in
        updated_at: '2026-07-08T11:59:09.140530Z'
      properties:
        amounts:
          description: >-
            Amounts of the recurrence: `fixed` for fixed amount recurrences,
            `minimum` (set by the receiver) and `maximum` (set by the payer) for
            variable ones
          properties:
            fixed:
              $ref: '#/components/schemas/V2_RecurrenceAmount'
            maximum:
              $ref: '#/components/schemas/V2_RecurrenceAmount'
            minimum:
              $ref: '#/components/schemas/V2_RecurrenceAmount'
          type: object
          x-struct: null
          x-validate: null
        authorized_at:
          description: When the payer authorized the recurrence
          format: date-time
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        bank_account_id:
          description: Bank account that receives the collections
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        contract_number:
          description: Contract number
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        counterparty:
          description: Payer of the recurrence
          properties:
            bank_account:
              description: Payer bank account
              properties:
                id:
                  description: Counterparty bank account ID
                  format: uuid
                  nullable: true
                  type: string
                  x-struct: null
                  x-validate: null
              type: object
              x-struct: null
              x-validate: null
            id:
              description: Counterparty ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        description:
          description: Description
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        end_date:
          description: Last day of the recurrence
          format: date
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        external_id:
          description: External ID
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        first_payment:
          description: First payment of the recurrence
          properties:
            amount:
              $ref: '#/components/schemas/V2_RecurrenceAmount'
            date:
              description: Day of the first payment
              format: date
              nullable: true
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        id:
          description: Recurrence ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: When the recurrence was created
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        number_of_collections:
          description: Number of collections
          nullable: true
          type: integer
          x-struct: null
          x-validate: null
        options:
          description: Recurrence options
          properties:
            automatic_schedule:
              description: Whether collections are scheduled automatically
              type: boolean
              x-struct: null
              x-validate: null
            next_working_day:
              description: >-
                Whether collections falling on a non-working day move to the
                next one
              type: boolean
              x-struct: null
              x-validate: null
            retry_policy:
              $ref: '#/components/schemas/RecurrenceRetryPolicy'
          type: object
          x-struct: null
          x-validate: null
        origin:
          description: Who or what created the recurrence
          properties:
            id:
              description: Origin ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            type:
              description: Origin type
              nullable: true
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        periodicity:
          $ref: '#/components/schemas/RecurrencePeriodicity'
        reference:
          description: What the recurrence was created from
          properties:
            id:
              description: Reference ID
              format: uuid
              nullable: true
              type: string
              x-struct: null
              x-validate: null
            type:
              description: Reference type
              enum:
                - requ
                - qrdn
                - qres
              nullable: true
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        start_date:
          description: First day of the recurrence
          format: date
          type: string
          x-struct: null
          x-validate: null
        status:
          $ref: '#/components/schemas/RecurrenceStatus'
        type:
          $ref: '#/components/schemas/RecurrenceType'
        updated_at:
          description: When the recurrence was last updated
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 RecurrenceData
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Data
      x-validate: null
    V2_RecurrenceAmount:
      description: An amount in cents
      example:
        amount: 10000
        currency: BRL
      nullable: true
      properties:
        amount:
          description: Amount in cents
          type: integer
          x-struct: null
          x-validate: null
        currency:
          description: Currency
          type: string
          x-struct: null
          x-validate: null
      title: V2 RecurrenceAmount
      type: object
      x-struct: Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Amount
      x-validate: null
    RecurrenceRetryPolicy:
      description: Types of recurrence retry policy
      enum:
        - none
        - 3r_7d
      title: RecurrenceRetryPolicy
      type: string
      x-struct: null
      x-validate: null
    RecurrencePeriodicity:
      description: >-
        'week': every week, 'mnth': every month, 'qurt': every 3 months, 'mian':
        every 6 months, 'year': every year
      enum:
        - week
        - mnth
        - qurt
        - mian
        - year
      title: RecurrencePeriodicity
      type: string
      x-struct: null
      x-validate: null
    RecurrenceStatus:
      description: Types of recurrence status
      enum:
        - created
        - approved
        - rejected
        - expired
        - cancelled
      title: RecurrenceStatus
      type: string
      x-struct: null
      x-validate: null
    RecurrenceType:
      description: Types of recurrence type
      enum:
        - in
        - out
      title: RecurrenceType
      type: string
      x-struct: null
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

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