> ## 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.

# Get Onramp

> GET /v2/onramp/{id} — retrieve a single onramp transaction by its end2end ID.

Covers templates: `onramp` (BRL → balance) and `onramp_instant` (BRL → external wallet). Fields marked with a template name are only present for that variant.

## Path parameters

| Parameter | Description                                 |
| --------- | ------------------------------------------- |
| `id`      | The `end2end` identifier (e.g. `NOXabc456`) |

## Response `200 OK`

### Attributes

| Field                         | Type   | Template         | Description                                        |
| ----------------------------- | ------ | ---------------- | -------------------------------------------------- |
| `quote`                       | float  | all              | Effective BRL→crypto exchange rate used            |
| `ref_quote`                   | float  | all              | Mid-market reference rate                          |
| `fees`                        | float  | all              | Total fees (BRL)                                   |
| `currency_entry`              | string | all              | Source currency — always `BRL`                     |
| `currency_exit_received`      | string | all              | Destination asset display name (e.g. `USDT (TRX)`) |
| `currency_exit_received_code` | string | all              | Destination currency code                          |
| `amount_payment`              | float  | all              | BRL amount paid                                    |
| `amount_received`             | float  | all              | Crypto amount received                             |
| `pix_e2e`                     | string | all              | PIX end-to-end ID (populated after payment)        |
| `client_name`                 | string | all              | Customer name                                      |
| `client_tax_id`               | string | all              | Customer CPF or CNPJ                               |
| `expiration`                  | string | all              | Session expiration timestamp (ISO 8601)            |
| `return_url`                  | string | all              | Post-checkout redirect URL                         |
| `external_code`               | string | all              | Merchant reference                                 |
| `webhook`                     | string | all              | Webhook URL                                        |
| `template`                    | string | all              | Template name (`onramp` or `onramp_instant`)       |
| `wallet`                      | string | `onramp_instant` | Destination wallet address                         |
| `tx_hash`                     | string | `onramp_instant` | On-chain transaction hash of the delivery          |
| `network_fee`                 | string | `onramp_instant` | Blockchain network fee charged                     |

**`404`** — transaction not found or does not belong to your account.

For all `status` / `substatus` values see [Onramp statuses](/noxpay-docs-v2/api-reference/reference/statuses#onramp).

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

  ```python theme={null}
  import requests

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

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

<ResponseExample>
  ```json 200 theme={null}
  {
    "end2end": "NOXabc456",
    "component": "success",
    "state": "DONE",
    "template": "onramp_instant",
    "created_at": "2024-05-01T10:00:00Z",
    "updated_at": "2024-05-01T10:08: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.45,
      "ref_quote": 5.30,
      "fees": 10.00,
      "currency_entry": "BRL",
      "currency_exit_received": "USDT (TRX)",
      "currency_exit_received_code": "USDT",
      "amount_payment": 550.00,
      "amount_received": 100.00,
      "pix_e2e": "E00038166202405011000...",
      "client_name": "Maria Souza",
      "client_tax_id": "98765432100",
      "expiration": "2024-05-01T10:30:00Z",
      "return_url": "https://yourapp.com/done",
      "external_code": "ref_99",
      "webhook": "https://yourapp.com/webhooks/nox",
      "template": "onramp_instant",
      "wallet": "TXyZ...abc",
      "tx_hash": "0xabc123...",
      "network_fee": "1.00"
    }
  }
  ```

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