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

# Get Recurrence

> Get recurrence with stages



## OpenAPI

````yaml api-reference/banking-api/openapi.json GET /banking/cashin/pix/recurrences/{id}
openapi: 3.0.0
info:
  title: Banking API
  version: 1.0.0
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:
  /banking/cashin/pix/recurrences/{id}:
    get:
      tags:
        - Recurrences
      summary: Get recurrence
      description: Get recurrence with stages
      operationId: TrioFoundationWeb.Banking.Cashin.RecurrenceController.show
      parameters:
        - description: Recurrence Id
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: Entity Id
          in: query
          name: entity_id
          required: false
          schema:
            format: uuid
            type: string
        - description: Bank Account Id
          in: query
          name: bank_account_id
          required: false
          schema:
            format: uuid
            type: string
        - description: Virtual account Id
          in: query
          name: virtual_account_id
          required: false
          schema:
            format: uuid
            type: string
        - description: Load stages?
          in: query
          name: load_stages
          required: false
          schema:
            type: boolean
        - description: Load requests?
          in: query
          name: load_requests
          required: false
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurrenceResponse'
          description: Recurrence
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonErrorResponse'
          description: Unprocessable Entity
      callbacks: {}
components:
  schemas:
    RecurrenceResponse:
      description: Recurrence response with stages
      example:
        data:
          counterparty_bank_account_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          start_date: '2020-04-20T16:20:00Z'
          counterparty_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          stages:
            - cancelation_code: cancelation_code_example
              cancelation_description: Cancelation description example
              cancelation_origin: cancelation_origin_example
              collection_id: 019f2433-fdc1-a7a6-9557-1c38fa07c8e5
              collection_timestamp: '2026-07-02T19:00:14.913129Z'
              error_code: error_code_example
              error_message: Error message example
              id: 019f2433-fdc1-53fe-14ea-617fe2336a71
              inserted_at: '2026-07-02T19:00:14.913130Z'
              journey: aut1
              recurrence_id: 019f2433-fdc1-9817-06e4-902a60e62b60
              reference_id: 019f2433-fdc1-f636-788c-367410d4c4d4
              reference_type: qrdn
              rejection_code: rejection_code_example
              rejection_description: Rejection description example
              request_id: 019f2433-fdc1-d9ac-17fe-648dcf02fd4c
              request_timestamp: '2026-07-02T19:00:14.913128Z'
              status: approved
              timestamp: '2026-07-02T19:00:14.913120Z'
              updated_at: '2026-07-02T19:00:14.913130Z'
              virtual_account_id: 019f2433-fdc1-2c0a-6b50-b8a887870405
          inserted_at: '2020-04-20T16:20:00Z'
          requests:
            - counterparty_bank_account_id: 019f2433-fc97-7566-84ad-5434d7552b5e
              counterparty_id: 019f2433-fc97-3749-e9e3-9bdc4342480b
              counterparty_seq: 1
              expiration_date: '2026-07-02T19:00:14.615303Z'
              id: 019f2433-fc97-c6c0-c99d-1ea6493fb153
              id_solic_rec: '1234567890'
              inserted_at: '2026-07-02T19:00:14.615305Z'
              recurrence_id: 019f2433-fc97-8d99-fc31-cf9409b24fe3
              recurrence_timestamp: '2026-07-02T19:00:14.615302Z'
              status: created
              timestamp: '2026-07-02T19:00:14.615295Z'
              updated_at: '2026-07-02T19:00:14.615305Z'
          type: in
          entity_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          reference_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          minimum_amount:
            amount: ''
            currency: ''
          ispb: ''
          first_payment_date: '2020-04-20T16:20:00Z'
          virtual_account_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          number_of_collections: ''
          company_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          automatic_schedule: ''
          end_date: '2020-04-20T16:20:00Z'
          status: created
          updated_at: '2020-04-20T16:20:00Z'
          next_working_day: ''
          description: ''
          id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          id_rec: ''
          fixed_amount:
            amount: ''
            currency: ''
          contract_number: ''
          txid: ''
          journey: aut1
          external_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          authorization_date: '2020-04-20T16:20:00Z'
          retry_policy: none
          timestamp: ''
          origin_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          org_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          first_payment_amount:
            amount: ''
            currency: ''
          maximum_amount:
            amount: ''
            currency: ''
          reference_type: requ
          periodicity: week
          origin_type: none
          update_date: '2020-04-20T16:20:00Z'
          bank_account_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          counterparty_info_id: 02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6
          counterparty_seq: ''
      properties:
        data:
          $ref: '#/components/schemas/DataWithStageAndRequest'
      title: RecurrenceResponse
      type: object
    JsonErrorResponse:
      properties:
        errors:
          items:
            properties:
              detail:
                example: null value where string expected
                type: string
              source:
                properties:
                  pointer:
                    example: /data/attributes/petName
                    type: string
                required:
                  - pointer
                type: object
              title:
                example: Invalid value
                type: string
            required:
              - title
              - source
              - detail
            type: object
          type: array
      required:
        - errors
      title: JsonErrorResponse
      type: object
    DataWithStageAndRequest:
      description: Data with Stage and Request
      properties:
        counterparty_bank_account_id:
          description: Counterparty Bank Account ID
          format: uuid
          type: string
        start_date:
          description: Recurrence Start Date
          format: date-time
          type: string
        counterparty_id:
          description: Counterparty ID
          format: uuid
          type: string
        stages:
          items:
            $ref: '#/components/schemas/RecurrenceStageData'
          type: array
        inserted_at:
          description: Inserted At
          format: date-time
          type: string
        requests:
          items:
            $ref: '#/components/schemas/RecurrenceRequestData'
          type: array
        type:
          $ref: '#/components/schemas/RecurrenceType'
        entity_id:
          description: Entity ID
          format: uuid
          type: string
        reference_id:
          description: Reference ID
          format: uuid
          type: string
        minimum_amount:
          description: Minimum Amount
          properties:
            amount:
              description: Amount integer in cents
              type: string
            currency:
              description: Amount currency
              type: string
          type: object
        ispb:
          description: ISPB
          type: string
        first_payment_date:
          description: First Payment Date
          format: date-time
          type: string
        virtual_account_id:
          description: Virtual Account ID
          format: uuid
          type: string
        number_of_collections:
          description: Number Of Collections
          type: string
        company_id:
          description: Company ID
          format: uuid
          type: string
        automatic_schedule:
          description: Automated Collecting
          type: string
        end_date:
          description: Recurrence End Date
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/RecurrenceStatus'
        updated_at:
          description: Updated At
          format: date-time
          type: string
        next_working_day:
          description: Next Working Day
          type: string
        description:
          description: Description
          type: string
        id:
          description: Recurrence ID
          format: uuid
          type: string
        id_rec:
          description: ID Rec
          type: string
        fixed_amount:
          description: Fixed Amount
          properties:
            amount:
              description: Amount integer in cents
              type: string
            currency:
              description: Amount currency
              type: string
          type: object
        contract_number:
          description: Contract Number
          type: string
        txid:
          description: Txid
          type: string
        journey:
          $ref: '#/components/schemas/Journey'
        external_id:
          description: External ID
          format: uuid
          type: string
        authorization_date:
          description: Authorization Date
          format: date-time
          type: string
        retry_policy:
          $ref: '#/components/schemas/RecurrenceRetryPolicy'
        timestamp:
          description: Timestamp
          type: string
        origin_id:
          description: Origin ID
          format: uuid
          type: string
        org_id:
          description: Org ID
          format: uuid
          type: string
        first_payment_amount:
          description: First payment Amount
          properties:
            amount:
              description: Amount integer in cents
              type: string
            currency:
              description: Amount currency
              type: string
          type: object
        maximum_amount:
          description: Maximum Amount
          properties:
            amount:
              description: Amount integer in cents
              type: string
            currency:
              description: Amount currency
              type: string
          type: object
        reference_type:
          $ref: '#/components/schemas/RecurrenceReferenceType'
        periodicity:
          $ref: '#/components/schemas/RecurrencePeriodicity'
        origin_type:
          $ref: '#/components/schemas/RecurrenceOrigintype'
        update_date:
          description: Update Date
          format: date-time
          type: string
        bank_account_id:
          description: Bank Account ID
          format: uuid
          type: string
        counterparty_info_id:
          description: Counterparty Info ID
          format: uuid
          type: string
        counterparty_seq:
          description: Counterparty Seq
          type: string
      title: DataWithStageAndRequest
      type: object
    RecurrenceStageData:
      description: Stage of a recurrence
      example:
        cancelation_code: cancelation_code_example
        cancelation_description: Cancelation description example
        cancelation_origin: cancelation_origin_example
        collection_id: 019f2437-4ee1-91ed-07b8-32c1ef2b69ee
        collection_timestamp: '2026-07-02T19:03:52.289040Z'
        error_code: error_code_example
        error_message: Error message example
        id: 019f2437-4ee1-e56e-ca16-c6cd50d98ef8
        inserted_at: '2026-07-02T19:03:52.289041Z'
        journey: aut1
        recurrence_id: 019f2437-4ee1-5810-481c-0ffa8a075576
        reference_id: 019f2437-4ee1-611c-c935-f33e72e6c4dd
        reference_type: qrdn
        rejection_code: rejection_code_example
        rejection_description: Rejection description example
        request_id: 019f2437-4ee1-a6ba-9a19-d6e9570c7206
        request_timestamp: '2026-07-02T19:03:52.289039Z'
        status: approved
        timestamp: '2026-07-02T19:03:52.289034Z'
        updated_at: '2026-07-02T19:03:52.289041Z'
        virtual_account_id: 019f2437-4ee1-0d50-ae1c-675a771b0e33
      properties:
        cancelation_code:
          description: Cancelation Code
          type: string
        cancelation_description:
          description: Cancelation Description
          type: string
        cancelation_origin:
          description: Cancelation Origin
          type: string
        collection_id:
          description: Collection ID
          format: uuid
          type: string
        collection_timestamp:
          description: Collection Timestamp
          format: date-time
          type: string
        error_code:
          description: Error Code
          type: string
        error_message:
          description: Error Message
          type: string
        id:
          description: Recurrence ID
          format: uuid
          type: string
        inserted_at:
          description: Inserted At
          format: date-time
          type: string
        journey:
          $ref: '#/components/schemas/Journey'
        recurrence_id:
          description: Recurrence ID
          format: uuid
          type: string
        reference_id:
          description: Reference ID
          format: uuid
          type: string
        reference_type:
          $ref: '#/components/schemas/RecurrenceReferenceType'
        rejection_code:
          description: Rejection Code
          type: string
        rejection_description:
          description: Rejection Description
          type: string
        request_id:
          description: Request ID
          format: uuid
          type: string
        request_timestamp:
          description: Request Timestamp
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/RecurrenceStatus'
        timestamp:
          description: Timestamp
          type: string
        updated_at:
          description: Updated At
          format: date-time
          type: string
        virtual_account_id:
          description: Virtual Account ID
          format: uuid
          type: string
      title: RecurrenceStageData
      type: object
    RecurrenceRequestData:
      description: A recurrence Request
      example:
        counterparty_bank_account_id: 019f2433-fc97-7566-84ad-5434d7552b5e
        counterparty_id: 019f2433-fc97-3749-e9e3-9bdc4342480b
        counterparty_seq: 1
        expiration_date: '2026-07-02T19:00:14.615303Z'
        id: 019f2433-fc97-c6c0-c99d-1ea6493fb153
        id_solic_rec: '1234567890'
        inserted_at: '2026-07-02T19:00:14.615305Z'
        recurrence_id: 019f2433-fc97-8d99-fc31-cf9409b24fe3
        recurrence_timestamp: '2026-07-02T19:00:14.615302Z'
        status: created
        timestamp: '2026-07-02T19:00:14.615295Z'
        updated_at: '2026-07-02T19:00:14.615305Z'
      properties:
        counterparty_bank_account_id:
          description: Counterparty bank account ID
          format: uuid
          type: string
        counterparty_id:
          description: Counterparty ID
          format: uuid
          type: string
        counterparty_seq:
          description: Counterparty sequence
          type: integer
        expiration_date:
          description: Expiration date
          format: date-time
          type: string
        id:
          description: ID
          format: uuid
          type: string
        id_solic_rec:
          description: Recurrence Request Identification
          type: string
        inserted_at:
          description: Inserted at
          format: date-time
          type: string
        recurrence_id:
          description: Recurrence ID
          format: uuid
          type: string
        recurrence_timestamp:
          description: Recurrence Timestamp
          format: uuid
          type: string
        status:
          description: Status of the recurrence request
          enum:
            - created
            - sent
            - received
            - rejected
            - accepted
            - expired
            - cancelled
          type: string
        timestamp:
          description: Timestamp
          format: uuid
          type: string
        updated_at:
          description: Updated at
          format: date-time
          type: string
      title: RecurrenceRequestData
      type: object
    RecurrenceType:
      description: Types of recurrence type
      enum:
        - in
        - out
      title: RecurrenceType
      type: string
    RecurrenceStatus:
      description: Types of recurrence status
      enum:
        - created
        - approved
        - rejected
        - expired
        - cancelled
      title: RecurrenceStatus
      type: string
    Journey:
      description: Types of recurrence journey
      enum:
        - aut1
        - aut2
        - aut3
        - aut4
      title: Journey
      type: string
    RecurrenceRetryPolicy:
      description: Types of recurrence retry policy
      enum:
        - none
        - 3r_7d
      title: RecurrenceRetryPolicy
      type: string
    RecurrenceReferenceType:
      description: >-
        Recurrence reference types, 'requ' = app, 'qrdn' = dynamicQRCode, 'qres'
        = staticQRCode
      enum:
        - requ
        - qrdn
        - qres
      title: RecurrenceReferenceType
      type: string
    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
    RecurrenceOrigintype:
      description: Origin Types of recurrence
      enum:
        - none
        - api_client
        - console_user
        - billing
        - reconciliation
        - checkout
        - bridge
      title: RecurrenceOrigintype
      type: string

````