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

# Consultar Offramp

> GET /v2/offramp/{id} — retorna uma transação de offramp individual pelo seu ID end2end.

Cobre os templates: `offramp` (saldo → BRL) e `offramp_instant` (depósito externo de cripto → BRL). Campos marcados com o nome do template estão presentes apenas naquela variante.

## Parâmetros de caminho

| Parâmetro | Descrição                                   |
| --------- | ------------------------------------------- |
| `id`      | O identificador `end2end` (ex: `NOXdef789`) |

## Response `200 OK`

### Attributes — `offramp`

| Campo                      | Tipo    | Descrição                                                     |
| -------------------------- | ------- | ------------------------------------------------------------- |
| `quote`                    | integer | Taxa de câmbio cripto→BRL efetiva utilizada                   |
| `ref_quote`                | integer | Taxa de referência mid-market                                 |
| `fees`                     | integer | Total de tarifas                                              |
| `currency_exit`            | string  | Moeda de pagamento fiat — sempre `BRL`                        |
| `currency_entry_paid`      | string  | Nome exibido do ativo cripto (ex: `USDT (TRX)`)               |
| `currency_entry_paid_code` | string  | Código da moeda cripto                                        |
| `amount_paid`              | float   | Valor em cripto debitado do seu saldo                         |
| `amount_sent`              | float   | Valor em BRL que o beneficiário recebe                        |
| `pix_key`                  | string  | Chave PIX para a qual o BRL foi enviado                       |
| `pix_key_type`             | string  | Tipo de chave PIX (`cpf`, `cnpj`, `email`, `phone`, `random`) |
| `pix_e2e`                  | string  | ID end-to-end do PIX (preenchido após o pagamento)            |
| `client_name`              | string  | Nome do beneficiário                                          |
| `client_tax_id`            | string  | CPF ou CNPJ do beneficiário                                   |
| `expiration`               | string  | Timestamp de expiração da sessão (ISO 8601)                   |
| `return_url`               | string  | URL de redirecionamento pós-checkout                          |
| `external_code`            | string  | Referência do lojista                                         |
| `webhook`                  | string  | URL de webhook                                                |

### Attributes — `offramp_instant`

| Campo                    | Tipo    | Descrição                                                         |
| ------------------------ | ------- | ----------------------------------------------------------------- |
| `quote`                  | integer | Taxa de câmbio cripto→BRL efetiva utilizada                       |
| `ref_quote`              | integer | Taxa de referência mid-market                                     |
| `fees`                   | integer | Total de tarifas                                                  |
| `currency_payment`       | string  | Moeda cripto que o pagador envia                                  |
| `currency_received`      | string  | Moeda fiat que o beneficiário recebe                              |
| `amount_payment`         | float   | Valor em cripto enviado pelo pagador                              |
| `amount_received`        | float   | Valor em BRL que o beneficiário recebe                            |
| `amount_payment_display` | string  | Exibição formatada do valor em cripto                             |
| `deposit_address`        | string  | Endereço de depósito blockchain para o qual o pagador deve enviar |
| `deposit_currency`       | string  | Código de moeda para o depósito                                   |
| `exact_deposit_amount`   | string  | Valor exato com sufixo necessário (deve ser enviado com precisão) |
| `tx_hash`                | string  | Hash da transação on-chain do depósito de entrada                 |
| `pix_key`                | string  | Chave PIX para a qual o BRL foi enviado                           |
| `pix_key_type`           | string  | Tipo de chave PIX (`cpf`, `cnpj`, `email`, `phone`, `random`)     |
| `pix_e2e`                | string  | ID end-to-end do PIX (preenchido após o pagamento)                |
| `client_name`            | string  | Nome do beneficiário                                              |
| `client_tax_id`          | string  | CPF ou CNPJ do beneficiário                                       |
| `expiration`             | string  | Timestamp de expiração da sessão                                  |
| `return_url`             | string  | URL de redirecionamento pós-checkout                              |
| `external_code`          | string  | Referência do lojista                                             |
| `webhook`                | string  | URL de webhook                                                    |

<Note>
  Para `offramp_instant`, sempre exiba `exact_deposit_amount` ao pagador — não um número arredondado. O valor com sufixo é como a Noxpay identifica a qual sessão um depósito pertence.
</Note>

**`404`** — transação não encontrada ou não pertence à sua conta.

Para todos os valores de `status` / `substatus` veja [Statuses do Offramp](/pt/api-reference/reference/statuses#offramp).

<RequestExample>
  ```bash theme={null}
  curl https://checkout.noxpay.io/v2/offramp/NOXdef789 \
    -H "api-key: <key>"
  ```

  ```python theme={null}
  import requests

  response = requests.get(
      "https://checkout.noxpay.io/v2/offramp/NOXdef789",
      headers={"api-key": "<key>"},
  )
  print(response.json())
  ```

  ```javascript theme={null}
  const response = await fetch(
    "https://checkout.noxpay.io/v2/offramp/NOXdef789",
    { headers: { "api-key": "<key>" } }
  );
  const data = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "end2end": "NOXdef789",
    "component": "success",
    "state": "DONE",
    "template": "offramp",
    "created_at": "2024-05-02T09:00:00Z",
    "updated_at": "2024-05-02T09:10:00Z",
    "status": { "en": "Success", "pt": "Sucesso" },
    "substatus": { "en": "Success", "pt": "Sucesso" },
    "message": {
      "en": "Transaction completed successfully",
      "pt": "Transação concluída com sucesso"
    },
    "error_message": { "en": "", "pt": "" },
    "attributes": {
      "quote": 5,
      "ref_quote": 5,
      "fees": 10,
      "currency_exit": "BRL",
      "currency_entry_paid": "USDT (TRX)",
      "currency_entry_paid_code": "USDT",
      "amount_paid": 100.00,
      "amount_sent": 490.00,
      "pix_e2e": "E00038166202405020900...",
      "client_name": "Carlos Lima",
      "client_tax_id": "11122233344",
      "expiration": "2024-05-02T09:30:00Z",
      "return_url": "https://seuapp.com/concluido",
      "external_code": "payout_7",
      "webhook": "https://seuapp.com/webhooks/nox",
      "pix_key": "email@example.com",
      "pix_key_type": "email"
    }
  }
  ```

  ```json 404 theme={null}
  { "error": "Not Found" }
  ```
</ResponseExample>