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

# Recuperar estado de la transacción

> Obtén información detallada sobre una transacción específica.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml GET /v1/transactions/{transactionId}
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/transactions/{transactionId}:
    get:
      tags:
        - Transactions API
      summary: Recuperar estado de la transacción
      description: Obtén información detallada sobre una transacción específica.
      parameters:
        - name: transactionId
          in: path
          required: true
          description: Identificador de la transacción.
          schema:
            type: string
          example: TXN123456789
      responses:
        '200':
          description: Detalles de la transacción recuperados correctamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionDetails'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    TransactionDetails:
      type: object
      required:
        - id
        - jdpiRequestId
        - endToEndId
        - status
        - payer
        - payee
        - amount
        - description
      properties:
        id:
          type: string
          description: Identificador único de la transacción.
          example: txn_123456789
        jdpiRequestId:
          type: string
          description: Identificador de la solicitud upstream.
          example: req_abc123xyz
        endToEndId:
          type: string
          description: Identificador end-to-end de la transacción.
          example: E1234567820230615123456789012345
        status:
          $ref: '#/components/schemas/TransactionStatusEnum'
        payer:
          $ref: '#/components/schemas/BankData'
        payee:
          $ref: '#/components/schemas/BankData'
        amount:
          type: number
          description: Monto de la transacción.
          format: double
          example: 100.5
        description:
          type: string
          description: Descripción de la transacción.
          example: Pago por servicios
    TransactionStatusEnum:
      type: string
      description: >
        Estado del procesamiento de la transacción. Valores en texto que indican
        el estado actual de una transacción Pix.


        **Valores válidos:**

        - `PENDING` = La transacción fue iniciada y está a la espera de
        procesamiento por el sistema de pagos

        - `PENDING_CONFIRM` = La transacción está esperando la confirmación
        final

        - `EXECUTED` = La transacción se completó con éxito y los fondos fueron
        transferidos

        - `REVERSAL` = La transacción fue revertida (reembolsada)

        - `REPROVED` = La transacción fue rechazada o no pasó la validación

        - `SCHEDULE` = La transacción está programada para una ejecución futura

        - `CANCELLED` = La transacción fue cancelada por el usuario antes de
        ejecutarse

        - `ERROR` = Ocurrió un error de procesamiento durante la ejecución de la
        transacción
      enum:
        - PENDING
        - PENDING_CONFIRM
        - EXECUTED
        - REVERSAL
        - REPROVED
        - SCHEDULE
        - CANCELLED
        - ERROR
      example: EXECUTED
    BankData:
      type: object
      description: Información de la cuenta bancaria.
      properties:
        accountId:
          type: string
          format: uuid
          description: Identificador de la cuenta.
          example: 019c96a0-0a98-7287-9a31-786e0809c769
        bankId:
          type: string
          pattern: ^\d{8}$
          description: Código ISPB del banco (8 dígitos).
          example: '12345678'
        document:
          type: string
          pattern: ^\d{11}$|^\d{14}$
          description: CPF (11 dígitos) o CNPJ (14 dígitos).
          example: '12345678901'
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: Nombre del titular de la cuenta.
          example: João da Silva
        branch:
          type: string
          pattern: ^\d{4}$
          description: Código de la sucursal (4 dígitos).
          example: '0001'
        accountType:
          $ref: '#/components/schemas/AccountTypeEnum'
        bankAccountType:
          $ref: '#/components/schemas/AccountTypeEnum'
        accountNumber:
          type: string
          pattern: ^\d{1,13}$
          description: Número de cuenta (hasta 13 dígitos).
          example: '123456'
        accountDigit:
          type: string
          pattern: ^\d{1}$
          description: Dígito verificador de la cuenta (1 dígito).
          example: '7'
        key:
          type: string
          description: Clave Pix (teléfono, correo electrónico, CPF, CNPJ o EVP).
          example: '+5511987654321'
        keyType:
          $ref: '#/components/schemas/KeyTypeEnum'
      required:
        - bankId
        - document
        - name
        - branch
        - accountType
        - accountNumber
        - accountDigit
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Código de error
        message:
          type: string
          description: Mensaje de error
        details:
          type: array
          items:
            type: string
          description: Detalles adicionales del error
    AccountTypeEnum:
      type: integer
      description: >
        Identificador del tipo de cuenta bancaria. Código numérico que indica el
        tipo de cuenta según los estándares bancarios brasileños.


        **Valores válidos:**

        - `0` = CURRENT_ACCOUNT (Cuenta corriente / Conta Corrente)

        - `1` = SALARY_ACCOUNT (Cuenta salario / Conta Salário)

        - `2` = SAVINGS_ACCOUNT (Cuenta de ahorros / Conta Poupança)

        - `3` = PAYMENT_ACCOUNT (Cuenta de pago / Conta de Pagamento)
      enum:
        - 0
        - 1
        - 2
        - 3
      x-enum-varnames:
        - CURRENT_ACCOUNT
        - SALARY_ACCOUNT
        - SAVINGS_ACCOUNT
        - PAYMENT_ACCOUNT
      example: 0
    KeyTypeEnum:
      type: integer
      description: >
        Identificador del tipo de clave Pix. Códigos numéricos que especifican
        el tipo de clave Pix utilizada.


        **Valores válidos:**

        - `0` = CPF (Identificación tributaria de persona física con 11 dígitos,
        p. ej., "12345678901")

        - `1` = CNPJ (Identificación tributaria de empresa con 14 dígitos, p.
        ej., "12345678000190")

        - `2` = EMAIL (Dirección de correo electrónico, p. ej.,
        "user@example.com")

        - `3` = PHONE (Número telefónico en formato internacional, p. ej.,
        "+5511987654321")

        - `4` = EVP (Clave aleatoria UUID generada automáticamente, p. ej.,
        "123e4567-e89b-12d3-a456-426614174000")
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      x-enum-varnames:
        - CPF
        - CNPJ
        - EMAIL
        - PHONE
        - EVP
      example: 3
  responses:
    Unauthorized:
      description: No Autorizado - Autenticación inválida o ausente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing_token:
              summary: Missing authentication token
              value:
                code: MISSING_TOKEN
                message: Authorization header is required
                details: []
            invalid_token:
              summary: Invalid token
              value:
                code: INVALID_TOKEN
                message: Invalid or expired access token
                details: []
            expired_token:
              summary: Expired token
              value:
                code: TOKEN_EXPIRED
                message: Access token has expired. Please obtain a new token.
                details: []
    NotFound:
      description: No Encontrado - El recurso no existe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            pix_key_not_found:
              summary: Pix key not found
              value:
                code: PIX_KEY_NOT_FOUND
                message: PIX key does not exist or is not registered
                details: []
            account_not_found:
              summary: Account not found
              value:
                code: ACCOUNT_NOT_FOUND
                message: Account with specified ID does not exist
                details: []
            transaction_not_found:
              summary: Transaction not found
              value:
                code: TRANSACTION_NOT_FOUND
                message: Transaction not found
                details: []
    InternalServerError:
      description: Error Interno del Servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            generic_error:
              summary: Generic internal error
              value:
                code: INTERNAL_ERROR
                message: An internal error occurred. Please try again later.
                details: []
            database_error:
              summary: Database error
              value:
                code: DATABASE_ERROR
                message: Database operation failed
                details: []
            external_service_error:
              summary: External service error
              value:
                code: EXTERNAL_SERVICE_ERROR
                message: External service (JD PIX) is temporarily unavailable
                details: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````