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

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

Covers templates: `offramp` (balance → BRL) and `offramp_instant` (external crypto deposit → BRL). Fields marked with a template name are only present for that variant.

## Path parameters

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

## Response `200 OK`

### Attributes — `offramp`

| Field                      | Type    | Description                                              |
| -------------------------- | ------- | -------------------------------------------------------- |
| `quote`                    | integer | Effective crypto→BRL exchange rate used                  |
| `ref_quote`                | integer | Mid-market reference rate                                |
| `fees`                     | integer | Total fees                                               |
| `currency_exit`            | string  | Fiat payout currency — always `BRL`                      |
| `currency_entry_paid`      | string  | Crypto asset display name (e.g. `USDT (TRX)`)            |
| `currency_entry_paid_code` | string  | Crypto currency code                                     |
| `amount_paid`              | float   | Crypto amount debited from your balance                  |
| `amount_sent`              | float   | BRL amount the payee receives                            |
| `pix_key`                  | string  | PIX key the BRL was sent to                              |
| `pix_key_type`             | string  | PIX key type (`cpf`, `cnpj`, `email`, `phone`, `random`) |
| `pix_e2e`                  | string  | PIX end-to-end ID (populated after payout)               |
| `client_name`              | string  | Payee name                                               |
| `client_tax_id`            | string  | Payee CPF or CNPJ                                        |
| `expiration`               | string  | Session expiration timestamp (ISO 8601)                  |
| `return_url`               | string  | Post-checkout redirect URL                               |
| `external_code`            | string  | Merchant reference                                       |
| `webhook`                  | string  | Webhook URL                                              |

### Attributes — `offramp_instant`

| Field                    | Type    | Description                                              |
| ------------------------ | ------- | -------------------------------------------------------- |
| `quote`                  | integer | Effective crypto→BRL exchange rate used                  |
| `ref_quote`              | integer | Mid-market reference rate                                |
| `fees`                   | integer | Total fees                                               |
| `currency_payment`       | string  | Crypto currency the payer sends                          |
| `currency_received`      | string  | Fiat currency the payee receives                         |
| `amount_payment`         | float   | Crypto amount sent by the payer                          |
| `amount_received`        | float   | BRL amount the payee receives                            |
| `amount_payment_display` | string  | Formatted display of the crypto amount                   |
| `deposit_address`        | string  | Blockchain deposit address the payer must send to        |
| `deposit_currency`       | string  | Currency code for the deposit                            |
| `exact_deposit_amount`   | string  | Exact suffixed amount required (must be sent precisely)  |
| `tx_hash`                | string  | On-chain transaction hash of the inbound deposit         |
| `pix_key`                | string  | PIX key the BRL was sent to                              |
| `pix_key_type`           | string  | PIX key type (`cpf`, `cnpj`, `email`, `phone`, `random`) |
| `pix_e2e`                | string  | PIX end-to-end ID (populated after payout)               |
| `client_name`            | string  | Payee name                                               |
| `client_tax_id`          | string  | Payee CPF or CNPJ                                        |
| `expiration`             | string  | Session expiration timestamp                             |
| `return_url`             | string  | Post-checkout redirect URL                               |
| `external_code`          | string  | Merchant reference                                       |
| `webhook`                | string  | Webhook URL                                              |

<Note>
  For `offramp_instant`, always display `exact_deposit_amount` to the payer — not a rounded number. The suffixed amount is how Noxpay identifies which session a deposit belongs to.
</Note>

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

For all `status` / `substatus` values see [Offramp statuses](/noxpay-docs-v2/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://yourapp.com/done",
      "external_code": "payout_7",
      "webhook": "https://yourapp.com/webhooks/nox",
      "pix_key": "email@example.com",
      "pix_key_type": "email"
    }
  }
  ```

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