> ## 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 Onramp
> GET /v2/onramp/{id} — retorna uma transação de onramp individual pelo seu ID end2end.
Esta rota devolve vários tipos de processo. `onramp` (BRL → saldo) e `onramp_instant` (BRL → carteira externa) compartilham o conjunto de atributos abaixo; `onramp_instant_legacy` é uma variante mais antiga de `onramp_instant`, com os mesmos atributos. Campos marcados com o nome do template estão presentes apenas naquela variante.
`GET /v2/onramps` **também devolve depósitos em BRL de funding do merchant**, que usam um conjunto de chaves de atributo completamente diferente — veja [Funding em BRL do merchant](#funding-em-brl-do-merchant) abaixo. Não existe campo de tipo para ramificar, então ramifique pelas chaves de atributo: `gateway_payment_id` marca um depósito de funding, `quote` marca um onramp.
## Parâmetros de caminho
| Parâmetro | Descrição |
| --------- | ---------------------------------------------------------------------------------------------- |
| `id` | O identificador `end2end` (ex: `NOXabc456`), o `pix_e2e` do pagamento, ou o `tx_hash` on-chain |
Se `{id}` não casar com um `end2end`, ele é tentado contra o ID end-to-end do Pix e depois contra o hash da transação — os três funcionam na mesma rota, sem parâmetro extra.
## Response `200 OK`
### Attributes
| Campo | Tipo | Template | Descrição |
| ----------------------------- | ------ | ---------------- | ------------------------------------------------------------------------ |
| `quote` | float | todos | Taxa de câmbio BRL→cripto efetiva utilizada |
| `ref_quote` | float | todos | Taxa de referência mid-market |
| `fees` | float | todos | Total de tarifas (BRL) |
| `currency_entry` | string | todos | Moeda de origem — sempre `BRL` |
| `currency_exit_received` | string | todos | Nome exibido do ativo de destino (ex: `USDT (TRX)`) |
| `currency_exit_received_code` | string | todos | Código da moeda de destino |
| `amount_payment` | float | todos | Valor em BRL pago |
| `amount_received` | float | todos | Valor em cripto recebido |
| `pix_e2e` | string | todos | ID end-to-end do PIX (preenchido após o pagamento) |
| `client_name` | string | todos | Nome do cliente |
| `client_tax_id` | string | todos | CPF ou CNPJ do cliente |
| `expiration` | string | todos | Timestamp de expiração da sessão (ISO 8601) |
| `return_url` | string | todos | URL de redirecionamento pós-checkout |
| `external_code` | string | todos | Referência do lojista |
| `webhook` | string | todos | URL de webhook |
| `template` | string | todos | Nome do template (`onramp`, `onramp_instant` ou `onramp_instant_legacy`) |
| `wallet` | string | `onramp_instant` | Endereço de carteira de destino |
| `tx_hash` | string | `onramp_instant` | Hash da transação on-chain da entrega |
| `network_fee` | string | `onramp_instant` | Taxa de rede blockchain cobrada |
Atributo de valor vazio é omitido, então chave ausente — `pix_e2e` antes do pagamento, por exemplo — significa que aquela etapa ainda não aconteceu.
## Funding em BRL do merchant
Um depósito em BRL que você faz na sua própria conta é um processo distinto que esta rota também devolve. Seus atributos quase não compartilham chaves com um onramp, então verifique `gateway_payment_id` antes de lê-los.
| Campo | Tipo | Descrição |
| -------------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| `gateway_payment_id` | string | Identificador do pagamento no gateway adquirente |
| `end2end` | string | ID end-to-end do Pix do depósito. Note que este é um *atributo* chamado `end2end`, distinto do `end2end` do envelope |
| `amount` | float | Valor depositado, em BRL |
| `bank` | string | Banco de origem |
| `paid_at` | string | Quando o depósito foi liquidado |
| `error_detail` | string | Explicação orientada ao cliente, quando o depósito falhou |
| `limit_block_source` | string | Qual portão barrou, quando um teto foi atingido: `operational` ou `compliance` |
Responses desta rota carregam `version: "v1"` no envelope. É um rótulo herdado, não a versão do contrato — esta é uma rota `/v2/` sobre o mesmo contrato de todas as outras. Não ramifique por ele.
**`404`** — transação não encontrada ou não pertence à sua conta. Os dois casos são deliberadamente indistinguíveis.
Para todos os valores de `status` / `substatus` veja [Statuses do Onramp](/pt/api-reference/reference/statuses#onramp).
```bash cURL theme={null}
curl https://checkout.noxpay.io/v2/onramp/NOXabc456 \
-H "api-key: "
```
```python Python theme={null}
import requests
response = requests.get(
"https://checkout.noxpay.io/v2/onramp/NOXabc456",
headers={"api-key": ""},
)
print(response.json())
```
```javascript Node.js theme={null}
const response = await fetch(
"https://checkout.noxpay.io/v2/onramp/NOXabc456",
{ headers: { "api-key": "" } }
);
const data = await response.json();
```
```json 200 theme={null}
{
"version": "v1",
"end2end": "NOXabc456",
"created_at": "2024-05-01T10:00:00Z",
"updated_at": "2024-05-01T10:08:00Z",
"process": "success.completed",
"status": { "en": "Success", "pt": "Sucesso", "es": "Éxito" },
"substatus": { "en": "Success", "pt": "Sucesso", "es": "Éxito" },
"message": { "en": "Transaction completed successfully", "pt": "Transação concluída com sucesso", "es": "Transacción completada con éxito" },
"error_message": { "en": "", "pt": "", "es": "" },
"attributes": {
"quote": 5.45,
"ref_quote": 5.30,
"fees": 10.00,
"currency_entry": "BRL",
"currency_exit_received": "USDT (TRX)",
"currency_exit_received_code": "TRX_USDT_S2UZ",
"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://seuapp.com/concluido",
"external_code": "ref_99",
"webhook": "https://seuapp.com/webhooks/nox",
"template": "onramp_instant",
"wallet": "TXyZ...abc",
"tx_hash": "0xabc123...",
"network_fee": "1.00"
}
}
```