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

# Obtener estados de transacción

> Obtiene todos los estados de transacción disponibles.

Use los IDs devueltos con fines informativos.

## 📋 Estados comunes

- **processing**: La transacción está siendo procesada
- **done**: La transacción se completó correctamente
- **failed**: Falló el procesamiento de la transacción




## OpenAPI

````yaml /api-reference/openapi.es.yaml get /transaction-statuses
openapi: 3.1.0
info:
  title: HG.Cash API
  description: >
    # 🚀 API de transacciones HG.Cash


    API REST moderna para que los usuarios creen transacciones de salida desde
    sus cuentas.


    ## 🧾 Cómo funciona


    - HG.Cash asigna cuentas a su usuario

    - Cuando estas cuentas tienen movimientos (entrada o salida), HG.Cash
    notificará su backend usando la URL de webhook que configure en el panel de
    HG.Cash

    - **Firma de webhooks (HMAC)**: En la configuración de la cuenta puede
    generar un secreto de firma. Cuando está configurado, cada POST de webhook
    incluye el encabezado `X-HG-Webhook-Signature: sha256=<hex>` donde el valor
    es HMAC-SHA256 del cuerpo JSON sin procesar usando su secreto. Verifíquelo
    en su endpoint para asegurar que la solicitud es auténtica.

    - Para crear retiros (dinero que sale de sus cuentas), debe llamar al
    endpoint **Cash Out**: **Crear solicitud de transacción** (`POST
    /transactions`)


    ## 📊 Primeros pasos


    1. **Genere su token de API** en la página de configuración de la cuenta

    2. **Pruebe los endpoints** usando la documentación interactiva a
    continuación

    3. **Implemente** en sus servicios de backend (nunca exponga tokens en el
    frontend)

    4. **Supervise** su integración y maneje los errores adecuadamente


    ## 🔐 Autenticación


    Esta API usa autenticación **Bearer Token**. Incluya el token de API del
    usuario en el encabezado Authorization, por ejemplo `Authorization: Bearer
    cash_your_token_here`.


    ## ⚠️ Notas importantes de seguridad


    - Nunca comparta ni exponga su token de autenticación de API de usuario

    - Almacene los tokens de forma segura solo en sus servidores de backend

    - Todas las llamadas a la API deben realizarse desde servicios de backend
    seguros

    - Contacte a los administradores inmediatamente si su token se ve
    comprometido
  version: 1.0.0
  contact:
    name: HG.Cash API Support
    email: api-support@hg.cash
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://hg.cash/api/v1
    description: Servidor de producción
  - url: http://dev.hg.cash/api/v1
    description: Servidor de desarrollo
security:
  - bearerAuth: []
tags:
  - name: Transacciones
    description: >-
      Gestión de transacciones - Crear y administrar transacciones en el sistema
      HG.Cash. Todos los endpoints de transacciones requieren autenticación.
  - name: Cuentas
    description: >-
      Cuentas - Obtener información de cuentas y saldos del usuario autenticado.
      Todos los endpoints de cuentas requieren autenticación.
  - name: Datos de referencia
    description: >-
      Datos de referencia - Obtener datos de referencia como estados y tipos de
      transacción. Estos endpoints requieren autenticación.
  - name: Webhooks
    description: Webhooks - Notificaciones de eventos enviadas a su endpoint HTTP.
  - name: Brasil
    description: Brasil — Crear y consultar transacciones PIX (BRL).
  - name: Chile
    description: Chile — Checkout hospedado y payouts bancarios (CLP).
  - name: Bolivia
    description: Bolivia — Cash-in con QR y payouts ACH (BOB).
  - name: Checkouts
    description: Sesiones de checkout hospedado para AR, BR, CL y BO
paths:
  /transaction-statuses:
    get:
      tags:
        - Datos de referencia
      summary: Obtener estados de transacción
      description: |
        Obtiene todos los estados de transacción disponibles.

        Use los IDs devueltos con fines informativos.

        ## 📋 Estados comunes

        - **processing**: La transacción está siendo procesada
        - **done**: La transacción se completó correctamente
        - **failed**: Falló el procesamiento de la transacción
      operationId: getTransactionStatuses
      responses:
        '200':
          description: Lista de estados de transacción
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransactionStatus'
              examples:
                statuses:
                  summary: Estados de transacción
                  value:
                    success: true
                    data:
                      - id: 550e8400-e29b-41d4-a716-446655440000
                        name: pending
                        description: La transacción está pendiente de procesamiento
                      - id: 550e8400-e29b-41d4-a716-446655440001
                        name: completed
                        description: La transacción se completó correctamente
                      - id: 550e8400-e29b-41d4-a716-446655440002
                        name: failed
                        description: Falló el procesamiento de la transacción
        '401':
          description: No autorizado - Token inválido o ausente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missing_token:
                  summary: Token ausente
                  value:
                    success: false
                    error: Authentication required
                    message: Bearer token is required
                invalid_token:
                  summary: Token inválido
                  value:
                    success: false
                    error: Invalid token
                    message: The provided token is invalid or expired
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    TransactionStatus:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          example: pending
        description:
          type: string
          example: La transacción está pendiente de procesamiento
    ErrorResponse:
      type: object
      description: Carga de error devuelta por la API.
      additionalProperties: true
      required:
        - error
      properties:
        error:
          type: string
          example: Invalid request
        code:
          type: string
          description: Código de error legible por máquina (cuando esté disponible)
          example: INSUFFICIENT_NET_BALANCE
        message:
          type: string
          example: The provided data is invalid
        details:
          type: object
          description: Detalles adicionales del error
          example:
            field: amount
            code: INVALID_VALUE
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Token de autenticación de API de usuario con formato
        `cash_<64-char-hex>`. Valor de ejemplo
        `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`.

````