> ## 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. # Consultar estado de transacción (Colombia) > Solo payouts salientes de Colombia. Devuelve `id`, `externalID`, `status`, `direction`, `amount` (string), `currency` y `providerStatus` cuando hubo una actualización. Una transacción que no es un payout saliente devuelve `400`. Un fallo de actualización devuelve `502` con `error`, `code` y `type`. ## OpenAPI ````yaml /api-reference/openapi.es.yaml get /co/transactions/{id}/status 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=` 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: Colombia description: >- Colombia — Cash-in con checkout hospedado y payouts bancarios, llave Bre-B o QR Bre-B (COP). - name: Checkouts description: Sesiones de checkout hospedado para AR, BR, CL, BO y CO - name: Claims description: Reclamos con evidencia de comprobante de transferencia paths: /co/transactions/{id}/status: get: tags: - Colombia summary: Consultar estado de transacción (Colombia) description: > Solo payouts salientes de Colombia. Devuelve `id`, `externalID`, `status`, `direction`, `amount` (string), `currency` y `providerStatus` cuando hubo una actualización. Una transacción que no es un payout saliente devuelve `400`. Un fallo de actualización devuelve `502` con `error`, `code` y `type`. operationId: getCoTransactionStatus parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Estado de la transacción content: application/json: schema: allOf: - $ref: '#/components/schemas/DirectTransactionStatus' - type: object properties: providerStatus: type: string description: >- Presente cuando esta solicitud actualizó un payout en curso. Se omite en caso contrario. amount: type: string description: Monto decimal como string example: id: 550e8400-e29b-41d4-a716-446655440000 externalID: 550e8400-e29b-41d4-a716-446655440000 status: processing direction: Outbound amount: '50000.00' currency: COP '400': description: >- La transacción no es un payout saliente admitido para consulta de estado content: application/json: schema: type: object required: - error properties: error: type: string example: Transaction is not supported for status polling '401': description: No autorizado '404': description: Transacción no encontrada '500': description: Error interno del servidor '502': description: Falló la actualización content: application/json: schema: $ref: '#/components/schemas/ColombiaProviderError' example: error: Unable to fetch transaction status from the payment provider. code: CO_TRANSACTION_STATUS_PROVIDER_ERROR type: provider_error components: schemas: DirectTransactionStatus: type: object description: Estado de una transacción directa (entrante o saliente) properties: id: type: string format: uuid externalID: type: string status: type: string description: > Estado normalizado de la transacción. - `processing`: Primer estado de una transacción saliente al crearla. El payout está en curso con el proveedor. - `pending`: Primer estado de una transacción entrante al crearla, hasta que el pagador completa el pago. - `done`: Pago o payout completado. - `expired`: El cobro entrante expiró antes del pago. - `cancelled`: La transacción fue cancelada o el proveedor la rechazó. enum: - processing - pending - done - expired - cancelled direction: type: string enum: - Inbound - Outbound amount: type: string currency: type: string feeBreakdown: $ref: '#/components/schemas/FeeBreakdown' ColombiaProviderError: type: object required: - error - code - type description: >- Error cuando un payout de Colombia no puede completarse o no se puede actualizar su estado properties: error: type: string code: type: string description: >- CO_OUTBOUND_PROVIDER_CREATE_FAILED o CO_TRANSACTION_STATUS_PROVIDER_ERROR type: type: string description: provider_error FeeBreakdown: type: object description: >- Desglose de comisión opcional en la respuesta de estado de una transacción directa. Los montos y las tasas son cadenas decimales. Se omite cuando la transacción no tiene desglose. `collectedAmount` es la comisión porcentual más la comisión fija. `platformFee` es el costo de billetera registrado y no se suma a `collectedAmount`. Incluye `flatFee.source`, que los webhooks de transacción omiten. properties: platformFee: type: object description: Porcentaje de billetera registrado. No se suma a `collectedAmount`. properties: amount: type: string example: '60' rate: type: string nullable: true description: >- Tasa porcentual de plataforma como cadena decimal (`0.005` es 0,5%) example: '0.005' transactionFee: type: object description: Porcentaje cobrado al cliente. properties: amount: type: string example: '120' rate: type: string nullable: true description: Tasa porcentual del cliente como cadena decimal (`0.01` es 1%) example: '0.01' flatFee: type: object properties: amount: type: string description: Comisión fija por transacción como cadena decimal example: '15' source: type: string nullable: true enum: - account - platform description: >- Valor de la cuenta, o el monto de la plataforma cuando la cuenta lo hereda example: platform collectedAmount: type: string description: '`transactionFee.amount` más `flatFee.amount`' example: '135' 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`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.