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

# Consultar Transação

> Recupera os detalhes de uma transação específica. Aceita tanto o UUID da transação quanto um external_id.



## OpenAPI

````yaml /openapi.json get /transactions/{id}
openapi: 3.1.0
info:
  title: Pixzy API
  version: 1.0.0
  description: >-
    API do Pixzy para processar pagamentos e saques via PIX de forma
    automatizada. Todos os valores monetários são representados em centavos (R$
    10,00 = 1000).
servers:
  - url: https://app.pixzypay.com/api
    description: Produção
security:
  - bearerAuth: []
paths:
  /transactions/{id}:
    get:
      tags:
        - Transações
      summary: Consultar Transação
      description: >-
        Recupera os detalhes de uma transação específica. Aceita tanto o UUID da
        transação quanto um external_id.
      operationId: getTransaction
      parameters:
        - name: id
          in: path
          required: true
          description: UUID da transação ou external_id associado.
          schema:
            type: string
          example: 019c7547-0433-7363-b8d8-704680370307
      responses:
        '200':
          description: Detalhes da transação
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/Transaction'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Transaction:
      type: object
      properties:
        id:
          type: string
          example: 019c7547-0433-7363-b8d8-704680370307
        amount:
          type: integer
          example: 1000
        status:
          type: string
          enum:
            - pending
            - paid
            - expired
            - failed
          example: paid
        client_name:
          type: string
          example: João Silva
        client_email:
          type: string
          example: joao@email.com
        client_doc:
          type: string
          example: 123.456.789-00
        client_phone:
          type: string
          example: '11999999999'
        created_at:
          type: string
          format: date-time
          example: '2025-01-15T10:00:00.000000Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-01-15T10:01:30.000000Z'
        metadata:
          type: object
          additionalProperties: true
          nullable: true
        br_code:
          type: string
          example: 00020126580014BR.GOV.BCB.PIX...
        qr_code:
          type: string
          description: Imagem do QR Code em base64.
          example: base64_encoded_qr_code_image...
    GenericError:
      type: object
      properties:
        error:
          type: string
          description: Mensagem de erro.
  responses:
    Unauthorized:
      description: Token ausente ou inválido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericError'
          example:
            error: Unauthenticated
    Forbidden:
      description: Conta inativa ou sem permissão.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericError'
          example:
            error: Account not active
    NotFound:
      description: Recurso não encontrado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericError'
          example:
            error: Not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer Token gerado em Configurações > Tokens de API.

````