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

# Retrieve an Entry

> Use this endpoint to retrieve a Pix entry by its unique identifier.



## OpenAPI

````yaml /en/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries/{entry_id}
openapi: 3.0.3
info:
  title: Plugin BR Pix Indirect - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/dict/entries/{entry_id}:
    get:
      tags:
        - DICT API
      summary: Retrieve an Entry
      description: Use this endpoint to retrieve a Pix entry by its unique identifier.
      parameters:
        - $ref: '#/components/parameters/EntryId'
        - $ref: '#/components/parameters/XAccountId'
      responses:
        '200':
          description: Pix entry retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntryObject'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0001:
                  $ref: '#/components/examples/ErrorPIX0001'
                ErrorPIX0002:
                  $ref: '#/components/examples/ErrorPIX0002'
                ErrorPIX0008:
                  $ref: '#/components/examples/ErrorPIX0008'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorPIX0112:
                  $ref: '#/components/examples/ErrorPIX0112'
        '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:
    EntryId:
      name: entry_id
      in: path
      description: Unique identifier of the Pix entry (UUID format).
      required: true
      example: 019c96a0-0c0c-7221-8cf3-13313fb60081
      schema:
        type: string
    XAccountId:
      name: X-Account-Id
      in: header
      description: Unique identifier of the Midaz Ledger Account (UUID format).
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
  schemas:
    EntryObject:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the entry (UUID format).
          example: 019c96a0-0c0c-7221-8cf3-13313fb60081
        key:
          type: string
          description: Pix key value.
          example: john.doe@example.com
        keyType:
          type: string
          description: Type of Pix key.
          example: EMAIL
        status:
          type: string
          description: Entry status (ACTIVE, INACTIVE).
          example: ACTIVE
        account:
          $ref: '#/components/schemas/AccountDetails'
        owner:
          $ref: '#/components/schemas/OwnerDetails'
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp.
          example: '2024-01-15T10:30:00Z'
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp.
          example: '2024-01-15T10:30:00Z'
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
    AccountDetails:
      type: object
      properties:
        branch:
          type: string
          description: Bank branch code.
          example: '0001'
        number:
          type: string
          description: Account number.
          example: '123456789'
        participant:
          type: string
          description: ISPB of the participant institution.
          example: '12345678'
        type:
          type: string
          description: Account type.
          example: TRAN
    OwnerDetails:
      type: object
      properties:
        name:
          type: string
          description: Owner name.
          example: John Doe
        taxIdNumber:
          type: string
          description: CPF or CNPJ.
          example: '12345678901'
        type:
          type: string
          enum:
            - NATURAL_PERSON
            - LEGAL_PERSON
          description: Owner type.
          example: NATURAL_PERSON
  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.
    ErrorPIX0002:
      summary: Invalid Header Value
      value:
        code: PIX-0002
        title: Invalid Header Value
        message: >-
          One or more header values are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each header.
    ErrorPIX0008:
      summary: Invalid Path Parameter in Request
      value:
        code: PIX-0008
        title: Invalid Path Parameter in Request
        message: >-
          One or more path parameters are invalid. Please refer to the
          documentation to verify the expected format and allowed values for
          each path parameter.
    ErrorPIX0112:
      summary: Entry Not Found
      value:
        code: PIX-0112
        title: Entry Not Found
        message: The entry was not found.
    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

````