> ## Documentation Index
> Fetch the complete documentation index at: https://cryptouse-d1f5ba06.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar Ordem

> Obtenha detalhes de uma ordem de pagamento

## Consultar detalhes da ordem

Este endpoint retorna informações detalhadas sobre uma ordem de pagamento específica usando seu ID de link de pagamento.

### Parâmetros de caminho

<ParamField path="id" type="string" required>
  ID do link de pagamento ou identificador de pagamento
</ParamField>

### Exemplo de requisição

```bash theme={null}
curl -X GET "https://server.cryptouse.com.br/api/v1/order/98e56f6d-b600-48d2-a251-8c7b206958b2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer seu_token_aqui"
```

### Resposta

<ResponseField name="message" type="string">
  Mensagem de sucesso
</ResponseField>

<ResponseField name="order" type="object">
  <Expandable title="Propriedades">
    <ResponseField name="id" type="string">
      ID da ordem
    </ResponseField>

    <ResponseField name="paymentLinkId" type="string">
      Identificador único do link de pagamento
    </ResponseField>

    <ResponseField name="value" type="number">
      Valor do pagamento em BRL
    </ResponseField>

    <ResponseField name="status" type="string">
      Status da ordem

      Valores possíveis: `PENDING`, `COMPLETED`, `CANCELLED`, `FAILED`, `REFUND`
    </ResponseField>

    <ResponseField name="createdAt" type="string" format="date-time">
      Timestamp de criação da ordem
    </ResponseField>

    <ResponseField name="brcode" type="string">
      Código BR do PIX (apenas para ordens PIX)
    </ResponseField>

    <ResponseField name="qrCodeLink" type="string">
      URL do QR code (apenas para ordens Binance)
    </ResponseField>

    <ResponseField name="invoice" type="string">
      Fatura Lightning (apenas para ordens Lightning)
    </ResponseField>

    <ResponseField name="link" type="string">
      URL de pagamento para o usuário
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="openNodeDetails" type="object">
  <Expandable title="Propriedades (apenas para ordens Lightning)">
    <ResponseField name="success" type="boolean">
      Indica se a consulta ao OpenNode foi bem-sucedida
    </ResponseField>

    <ResponseField name="data" type="object">
      <Expandable title="Dados do OpenNode">
        <ResponseField name="id" type="string">
          ID da fatura no OpenNode
        </ResponseField>

        <ResponseField name="name" type="string" nullable>
          Nome da fatura
        </ResponseField>

        <ResponseField name="status" type="string">
          Status da fatura no OpenNode
        </ResponseField>

        <ResponseField name="currency" type="string">
          Moeda da fatura
        </ResponseField>

        <ResponseField name="created_at" type="number">
          Timestamp de criação da fatura
        </ResponseField>

        <ResponseField name="fee" type="number">
          Taxa da fatura
        </ResponseField>

        <ResponseField name="notes" type="string">
          Notas da fatura
        </ResponseField>

        <ResponseField name="address" type="string">
          Endereço da carteira
        </ResponseField>

        <ResponseField name="metadata" type="object">
          Metadados da fatura
        </ResponseField>

        <ResponseField name="fiat_value" type="number">
          Valor em fiat (BRL)
        </ResponseField>

        <ResponseField name="amount" type="number">
          Valor em satoshis
        </ResponseField>

        <ResponseField name="description" type="string">
          Descrição da fatura
        </ResponseField>

        <ResponseField name="auto_settle" type="boolean">
          Indica se a fatura é liquidada automaticamente
        </ResponseField>

        <ResponseField name="transactions" type="array">
          Array de transações
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Exemplo de resposta

<CodeGroup>
  ```json Sucesso - Ordem Lightning (200) theme={null}
  {
    "message": "Order retrieved successfully",
    "order": {
      "id": "688a5e459b11ce1a1a85e32a",
      "paymentLinkId": "98e56f6d-b600-48d2-a251-8c7b206958b2",
      "value": 5000,
      "status": "PENDING",
      "createdAt": "2025-07-30T18:02:45.965Z",
      "invoice": "Inbc75800n1p5g5hj9pp58x8fx94hdc19zzpn3ecxc349mkje27v738a981ztczeqq2y0cmvsdquf9h8vmmfvdjjqsmj09c8gmm4wdjscqzysxqzjhsp54qv2q6at8hges7cvsjtzhqfucdjqelhe5e184a4a3hn14sdcy",
      "link": "https://cryptouse.com.br/order/lightning/98e56f6d-b600-48d2-a251-8c7b206958b2"
    },
    "openNodeDetails": {
      "success": true,
      "data": {
        "id": "fc1fb9a8-93c9-4a96-ba50-e9802e21bdbb",
        "name": null,
        "status": "unpaid",
        "currency": "BRL",
        "created_at": 1753898565,
        "fee": 75,
        "notes": "",
        "address": "356w6JpBDS1YmnNxjmMcwhwAUxCZVJkLiQ",
        "metadata": {},
        "fiat_value": 5000,
        "amount": 7580,
        "description": "Invoice Cryptouse",
        "auto_settle": false,
        "transactions": []
      }
    }
  }
  ```

  ```json Sucesso - Ordem PIX (200) theme={null}
  {
    "message": "Order retrieved successfully",
    "order": {
      "id": "688a60439b11ce1a1a85e450",
      "paymentLinkId": "d3d7bafe-2040-4f74-bddb-34823c6edcae",
      "value": 200,
      "status": "PENDING",
      "createdAt": "2025-07-30T18:11:15.1512",
      "link": "https://cryptouse.com.br/order/d3d7bafe-2040-4f74-bddb-34823c6edcae"
    }
  }
  ```

  ```json Ordem não encontrada (404) theme={null}
  {
    "success": false,
    "error": "Order not found"
  }
  ```
</CodeGroup>

## Tipos de ordem

Este endpoint funciona para todos os tipos de ordem suportados:

* **Ordens PIX**: Contém o campo `brcode`
* **Ordens Binance**: Contém o campo `qrCodeLink`
* **Ordens Lightning**: Contém o campo `invoice` e `openNodeDetails`

O tipo de ordem é determinado automaticamente com base no ID fornecido.

## Status da ordem

A consulta de status é útil para verificar se um pagamento foi recebido. Os possíveis status incluem:

| Status      | Descrição                              |
| ----------- | -------------------------------------- |
| `PENDING`   | A ordem foi criada e aguarda pagamento |
| `COMPLETED` | O pagamento foi recebido e confirmado  |
| `CANCELLED` | A ordem foi cancelada                  |
| `FAILED`    | O pagamento falhou                     |
| `REFUND`    | O pagamento foi reembolsado            |

## Recomendações de uso

É recomendado consultar o status da ordem periodicamente quando:

1. Um usuário inicia um pagamento
2. Você precisa verificar manualmente o status de uma ordem
3. Após receber uma notificação de atualização de status