Pular para o conteúdo principal
curl https://checkout.noxpay.io/v2/onramp/NOXabc456 \
  -H "api-key: <key>"

import requests

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

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

{
  "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://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"
  }
}

{ "error": "Not Found" }
Cobre os templates: onramp (BRL → saldo) e onramp_instant (BRL → carteira externa). Campos marcados com o nome do template estão presentes apenas naquela variante.

​
Parâmetros de caminho

ParâmetroDescrição
idO identificador end2end (ex: NOXabc456)

​
Response 200 OK

​
Attributes

CampoTipoTemplateDescrição
quotefloattodosTaxa de câmbio BRL→cripto efetiva utilizada
ref_quotefloattodosTaxa de referência mid-market
feesfloattodosTotal de tarifas (BRL)
currency_entrystringtodosMoeda de origem — sempre BRL
currency_exit_receivedstringtodosNome exibido do ativo de destino (ex: USDT (TRX))
currency_exit_received_codestringtodosCódigo da moeda de destino
amount_paymentfloattodosValor em BRL pago
amount_receivedfloattodosValor em cripto recebido
pix_e2estringtodosID end-to-end do PIX (preenchido após o pagamento)
client_namestringtodosNome do cliente
client_tax_idstringtodosCPF ou CNPJ do cliente
expirationstringtodosTimestamp de expiração da sessão (ISO 8601)
return_urlstringtodosURL de redirecionamento pós-checkout
external_codestringtodosReferência do lojista
webhookstringtodosURL de webhook
templatestringtodosNome do template (onramp ou onramp_instant)
walletstringonramp_instantEndereço de carteira de destino
tx_hashstringonramp_instantHash da transação on-chain da entrega
network_feestringonramp_instantTaxa de rede blockchain cobrada
404 — transação não encontrada ou não pertence à sua conta. Para todos os valores de status / substatus veja Statuses do Onramp. 
curl https://checkout.noxpay.io/v2/onramp/NOXabc456 \
  -H "api-key: <key>"

import requests

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

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

{
  "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://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"
  }
}

{ "error": "Not Found" }