Skip to main content
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://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"
  }
}

{ "error": "Not Found" }
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

ParameterDescription
idThe end2end identifier (e.g. NOXabc456)

​
Response 200 OK

​
Attributes

FieldTypeTemplateDescription
quotefloatallEffective BRL→crypto exchange rate used
ref_quotefloatallMid-market reference rate
feesfloatallTotal fees (BRL)
currency_entrystringallSource currency — always BRL
currency_exit_receivedstringallDestination asset display name (e.g. USDT (TRX))
currency_exit_received_codestringallDestination currency code
amount_paymentfloatallBRL amount paid
amount_receivedfloatallCrypto amount received
pix_e2estringallPIX end-to-end ID (populated after payment)
client_namestringallCustomer name
client_tax_idstringallCustomer CPF or CNPJ
expirationstringallSession expiration timestamp (ISO 8601)
return_urlstringallPost-checkout redirect URL
external_codestringallMerchant reference
webhookstringallWebhook URL
templatestringallTemplate name (onramp or onramp_instant)
walletstringonramp_instantDestination wallet address
tx_hashstringonramp_instantOn-chain transaction hash of the delivery
network_feestringonramp_instantBlockchain network fee charged
404 — transaction not found or does not belong to your account. For all status / substatus values see Onramp statuses. 
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://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"
  }
}

{ "error": "Not Found" }