Skip to main content
curl https://checkout.noxpay.io/v2/offramp/NOXdef789 \
  -H "api-key: <key>"

import requests

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

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

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

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

ParameterDescription
idThe end2end identifier (e.g. NOXdef789)

​
Response 200 OK

​
Attributes — offramp

FieldTypeDescription
quoteintegerEffective crypto→BRL exchange rate used
ref_quoteintegerMid-market reference rate
feesintegerTotal fees
currency_exitstringFiat payout currency — always BRL
currency_entry_paidstringCrypto asset display name (e.g. USDT (TRX))
currency_entry_paid_codestringCrypto currency code
amount_paidfloatCrypto amount debited from your balance
amount_sentfloatBRL amount the payee receives
pix_keystringPIX key the BRL was sent to
pix_key_typestringPIX key type (cpf, cnpj, email, phone, random)
pix_e2estringPIX end-to-end ID (populated after payout)
client_namestringPayee name
client_tax_idstringPayee CPF or CNPJ
expirationstringSession expiration timestamp (ISO 8601)
return_urlstringPost-checkout redirect URL
external_codestringMerchant reference
webhookstringWebhook URL

​
Attributes — offramp_instant

FieldTypeDescription
quoteintegerEffective crypto→BRL exchange rate used
ref_quoteintegerMid-market reference rate
feesintegerTotal fees
currency_paymentstringCrypto currency the payer sends
currency_receivedstringFiat currency the payee receives
amount_paymentfloatCrypto amount sent by the payer
amount_receivedfloatBRL amount the payee receives
amount_payment_displaystringFormatted display of the crypto amount
deposit_addressstringBlockchain deposit address the payer must send to
deposit_currencystringCurrency code for the deposit
exact_deposit_amountstringExact suffixed amount required (must be sent precisely)
tx_hashstringOn-chain transaction hash of the inbound deposit
pix_keystringPIX key the BRL was sent to
pix_key_typestringPIX key type (cpf, cnpj, email, phone, random)
pix_e2estringPIX end-to-end ID (populated after payout)
client_namestringPayee name
client_tax_idstringPayee CPF or CNPJ
expirationstringSession expiration timestamp
return_urlstringPost-checkout redirect URL
external_codestringMerchant reference
webhookstringWebhook URL
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.
404 — transaction not found or does not belong to your account. For all status / substatus values see Offramp statuses. 
curl https://checkout.noxpay.io/v2/offramp/NOXdef789 \
  -H "api-key: <key>"

import requests

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

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

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

{ "error": "Not Found" }