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

> Get recurrence request



## OpenAPI

````yaml v2/api-reference/openapi.json GET /v2/in/pix/recurrences/requests/{id}
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/requests/{id}:
    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: Get recurrence request
      description: Get recurrence request
      operationId: TrioFoundationWeb.V2.In.Pix.Recurrence.RequestController.show
      parameters:
        - description: Request ID
          in: path
          name: id
          required: true
          schema:
            $ref: '#/components/schemas/UUID'
        - description: Entity Id
          in: query
          name: entity_id
          required: false
          schema:
            $ref: '#/components/schemas/UUID'
        - description: Group Id
          in: query
          name: group_id
          required: false
          schema:
            $ref: '#/components/schemas/UUID'
        - description: Bank Account Id
          in: query
          name: bank_account_id
          required: false
          schema:
            $ref: '#/components/schemas/UUID'
        - description: Load stages?
          in: query
          name: load_stages
          required: false
          schema:
            type: boolean
            x-struct: null
            x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_RecurrenceRequestResponse'
          description: Request
        '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.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2_error'
          description: No resource with this ID (NOT_FOUND_RESOURCE).
        '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:
    UUID:
      description: Unique identifier
      format: uuid
      title: UUID
      type: string
      x-struct: null
      x-validate: null
    V2_RecurrenceRequestResponse:
      description: Recurrence request response
      example:
        data:
          counterparty:
            bank_account:
              id: 019809db-4baf-07f7-7767-e32734e5b636
            id: 019809db-4baf-039f-be7a-ed7d1f147ab5
          expires_at: '2025-08-13T13:53:43.287296Z'
          id: 019809db-4af7-47fc-1add-28b582f08576
          inserted_at: '2025-07-14T16:53:43.471712Z'
          recurrence:
            id: 019809db-4af7-c377-de68-c1f56b542305
          status: created
          updated_at: '2025-07-14T16:53:43.471712Z'
      properties:
        data:
          $ref: '#/components/schemas/V2_RecurrenceRequestData'
      title: V2 RecurrenceRequestResponse
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Response
      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_RecurrenceRequestData:
      description: >-
        A recurrence request. `stages` is present only when asked for with
        `load_stages`.
      example:
        counterparty:
          bank_account:
            id: 019809db-4baf-07f7-7767-e32734e5b636
          id: 019809db-4baf-039f-be7a-ed7d1f147ab5
        expires_at: '2025-08-13T13:53:43.287296Z'
        id: 019809db-4af7-47fc-1add-28b582f08576
        inserted_at: '2025-07-14T16:53:43.471712Z'
        recurrence:
          id: 019809db-4af7-c377-de68-c1f56b542305
        status: created
        updated_at: '2025-07-14T16:53:43.471712Z'
      properties:
        counterparty:
          description: Payer the request was sent to
          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
        expires_at:
          description: When the payer can no longer answer the request
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Request ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: When the request was created
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        recurrence:
          description: Recurrence the request belongs to
          properties:
            id:
              description: Recurrence ID
              format: uuid
              type: string
              x-struct: null
              x-validate: null
          type: object
          x-struct: null
          x-validate: null
        stages:
          description: Request stages
          items:
            $ref: '#/components/schemas/V2_RecurrenceRequestStage'
          type: array
          x-struct: null
          x-validate: null
        status:
          description: Request status
          enum:
            - created
            - sent
            - received
            - rejected
            - accepted
            - expired
            - cancelled
          type: string
          x-struct: null
          x-validate: null
        updated_at:
          description: When the request was last updated
          format: date-time
          type: string
          x-struct: null
          x-validate: null
      title: V2 RecurrenceRequestData
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Data
      x-validate: null
    V2_RecurrenceRequestStage:
      description: A stage of a recurrence request
      example:
        error_code: null
        error_message: null
        id: 019809db-4bb0-5a1e-0c1d-9e5f2b8a7c31
        inserted_at: '2025-07-14T16:53:43.471712Z'
        status: created
      properties:
        error_code:
          description: Error code
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        error_message:
          description: Error message
          nullable: true
          type: string
          x-struct: null
          x-validate: null
        id:
          description: Stage ID
          format: uuid
          type: string
          x-struct: null
          x-validate: null
        inserted_at:
          description: When the stage was recorded
          format: date-time
          type: string
          x-struct: null
          x-validate: null
        status:
          description: Request status the stage recorded
          enum:
            - created
            - sent
            - received
            - rejected
            - accepted
            - expired
            - cancelled
          type: string
          x-struct: null
          x-validate: null
      title: V2 RecurrenceRequestStage
      type: object
      x-struct: >-
        Elixir.TrioFoundationWeb.Schemas.Banking.V2.Cashin.Recurrence.Request.Stage
      x-validate: null
  securitySchemes:
    authorization:
      scheme: basic
      type: http

````

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