> ## 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 status da transação (Colômbia) > Somente payouts de saída da Colômbia. Retorna `id`, `externalID`, `status`, `direction`, `amount` (string), `currency` e `providerStatus` quando houve uma atualização. Uma transação que não é um payout de saída retorna `400`. Uma falha de atualização retorna `502` com `error`, `code` e `type`. ## OpenAPI ````yaml /api-reference/openapi.pt-BR.yaml get /co/transactions/{id}/status openapi: 3.1.0 info: title: HG.Cash API description: > # 🚀 API de transações HG.Cash API REST moderna para usuários criarem transações de saída a partir de suas contas. ## 🧾 Como funciona - A HG.Cash atribui contas ao seu usuário - Quando essas contas têm movimentação (entrada ou saída), a HG.Cash notifica o seu backend usando a URL de webhook configurada no painel - **Assinatura de webhooks (HMAC)**: Nas configurações da conta é possível gerar um segredo de assinatura. Quando configurado, cada POST de webhook inclui o cabeçalho `X-HG-Webhook-Signature: sha256=` com HMAC-SHA256 do corpo JSON usando o seu segredo. Verifique no seu endpoint para garantir autenticidade. - Para criar saques é necessário chamar o endpoint **Cash Out**: **Criar solicitação de transação** (`POST /transactions`) ## 📊 Primeiros passos 1. **Gere seu token de API** na página de configurações da conta 2. **Teste os endpoints** com a documentação interativa 3. **Implemente** nos seus serviços de backend (nunca exponha tokens no frontend) 4. **Monitore** a integração e trate erros adequadamente ## 🔐 Autenticação Esta API usa autenticação **Bearer Token**. Inclua o token de API do usuário no cabeçalho Authorization, por exemplo `Authorization: Bearer cash_your_token_here`. ## ⚠️ Segurança - Não compartilhe nem exponha o token de autenticação da API - Armazene tokens apenas em servidores backend seguros - Todas as chamadas devem ser feitas a partir de backends seguros - Se o token for comprometido, entre em contato com os administradores imediatamente 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 produção - url: http://dev.hg.cash/api/v1 description: Servidor de desenvolvimento security: - bearerAuth: [] tags: - name: Transações description: >- Gestão de transações — Criar e gerenciar transações no sistema HG.Cash. Todos os endpoints de transação exigem autenticação. - name: Contas description: >- Contas — Obter informações de conta e saldos do usuário autenticado. Todos os endpoints de conta exigem autenticação. - name: Dados de referência description: >- Dados de referência — Obter dados de referência como status e tipos de transação. Esses endpoints exigem autenticação. - name: Webhooks description: Webhooks — Notificações de eventos enviadas ao seu endpoint HTTP. - name: Brasil description: Brasil — Criar e consultar transações PIX (BRL). - name: Chile description: Chile — Checkout hospedado e payouts bancários (CLP). - name: Bolívia description: Bolívia — Cash-in com QR e payouts ACH (BOB). - name: Colômbia description: >- Colômbia — Cash-in com checkout hospedado e payouts bancários, chave Bre-B ou QR Bre-B (COP). - name: Checkouts description: Sessões de checkout hospedado para AR, BR, CL, BO e CO - name: Claims description: Reclamações com evidência de comprovante de transferência paths: /co/transactions/{id}/status: get: tags: - Colômbia summary: Consultar status da transação (Colômbia) description: > Somente payouts de saída da Colômbia. Retorna `id`, `externalID`, `status`, `direction`, `amount` (string), `currency` e `providerStatus` quando houve uma atualização. Uma transação que não é um payout de saída retorna `400`. Uma falha de atualização retorna `502` com `error`, `code` e `type`. operationId: getCoTransactionStatus parameters: - name: id in: path required: true schema: type: string format: uuid responses: '200': description: Status da transação content: application/json: schema: allOf: - $ref: '#/components/schemas/DirectTransactionStatus' - type: object properties: providerStatus: type: string description: >- Presente quando esta requisição atualizou um payout em andamento. Omitido caso contrário. amount: type: string description: Valor 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: A transação não é um payout de saída aceito para consulta de status content: application/json: schema: type: object required: - error properties: error: type: string example: Transaction is not supported for status polling '401': description: Não autorizado '404': description: Transação não encontrada '500': description: Erro interno do servidor '502': description: Falha na atualização 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: Status de uma transação direta (entrada ou saída) properties: id: type: string format: uuid externalID: type: string status: type: string description: > Status normalizado da transação. - `processing`: Primeiro status de uma transação de saída ao criá-la. O payout está em andamento no provedor. - `pending`: Primeiro status de uma transação de entrada ao criá-la, até o pagador concluir o pagamento. - `done`: Pagamento ou payout concluído. - `expired`: A cobrança de entrada expirou antes do pagamento. - `cancelled`: A transação foi cancelada ou o provedor a rejeitou. 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: >- Erro quando um payout da Colômbia não pode ser concluído ou o status não pode ser atualizado properties: error: type: string code: type: string description: >- CO_OUTBOUND_PROVIDER_CREATE_FAILED ou CO_TRANSACTION_STATUS_PROVIDER_ERROR type: type: string description: provider_error FeeBreakdown: type: object description: >- Detalhamento de taxa opcional na resposta de status de uma transação direta. Valores e taxas são strings decimais. Omitido quando a transação não tem detalhamento. `collectedAmount` é a taxa percentual mais a taxa fixa. `platformFee` é o custo de carteira registrado e não entra em `collectedAmount`. Inclui `flatFee.source`, que os webhooks de transação omitem. properties: platformFee: type: object description: Percentual de carteira registrado. Não entra em `collectedAmount`. properties: amount: type: string example: '60' rate: type: string nullable: true description: >- Taxa percentual da plataforma como string decimal (`0.005` é 0,5%) example: '0.005' transactionFee: type: object description: Percentual cobrado do cliente. properties: amount: type: string example: '120' rate: type: string nullable: true description: Taxa percentual do cliente como string decimal (`0.01` é 1%) example: '0.01' flatFee: type: object properties: amount: type: string description: Taxa fixa por transação como string decimal example: '15' source: type: string nullable: true enum: - account - platform description: >- Valor da conta, ou o valor da plataforma quando a conta herda esse valor example: platform collectedAmount: type: string description: '`transactionFee.amount` mais `flatFee.amount`' example: '135' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Token de autenticação da API do usuário com o formato `cash_<64-char-hex>`. Valor de exemplo `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.