> ## 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. # Get Transaction Statuses > Retrieve all available transaction statuses. Use the returned IDs for informational purposes. ## šŸ“‹ Common Statuses - **processing**: Transaction is being processed - **done**: Transaction completed successfully - **failed**: Transaction processing failed ## OpenAPI ````yaml /api-reference/openapi.pt-BR.yaml get /transaction-statuses 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: Transactions description: >- Transaction Management - Create and manage transactions in the HG.Cash system. All transaction endpoints require authentication. - name: Accounts description: >- Accounts - Retrieve account information and balances for the authenticated user. All account endpoints require authentication. - name: Reference Data description: >- Reference Data - Get reference data like transaction statuses and types. These endpoints require authentication. - name: Webhooks description: Webhooks - Event notifications sent to your HTTP endpoint. - name: Brazil description: Brasil ā€” Criar e consultar transaƧƵes PIX (BRL). - name: Chile description: Chile ā€” Checkout hospedado e payouts bancĆ”rios (CLP). - name: Bolivia description: BolĆ­via ā€” Cash-in com QR e payouts ACH (BOB). - name: Checkouts description: SessƵes de checkout hospedado para AR, BR, CL e BO paths: /transaction-statuses: get: tags: - Reference Data summary: Get Transaction Statuses description: | Retrieve all available transaction statuses. Use the returned IDs for informational purposes. ## šŸ“‹ Common Statuses - **processing**: Transaction is being processed - **done**: Transaction completed successfully - **failed**: Transaction processing failed operationId: getTransactionStatuses responses: '200': description: List of transaction statuses content: application/json: schema: type: object properties: success: type: boolean example: true data: type: array items: $ref: '#/components/schemas/TransactionStatus' examples: statuses: summary: Transaction Statuses value: success: true data: - id: 550e8400-e29b-41d4-a716-446655440000 name: pending description: Transaction is pending processing - id: 550e8400-e29b-41d4-a716-446655440001 name: completed description: Transaction completed successfully - id: 550e8400-e29b-41d4-a716-446655440002 name: failed description: Transaction processing failed '401': description: Unauthorized - Invalid or missing token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missing_token: summary: Missing Token value: success: false error: Authentication required message: Bearer token is required invalid_token: summary: Invalid Token value: success: false error: Invalid token message: The provided token is invalid or expired '500': description: Internal Server Error 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: Transaction is pending processing ErrorResponse: type: object description: Error payload returned by the API. additionalProperties: true required: - error properties: error: type: string example: Invalid request code: type: string description: Machine-readable error code (when available) example: INSUFFICIENT_NET_BALANCE message: type: string example: The provided data is invalid details: type: object description: Additional error details example: field: amount code: INVALID_VALUE securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > User API authentication token with format `cash_<64-char-hex>`. Sample value `cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2`. ````