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

import requests

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

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

{
  "end2end": "NOXabc123",
  "component": "depositpix_v2",
  "state": "QRCODE",
  "template": "crossramp_checkout",
  "created_at": "2024-05-01T12:00:00Z",
  "updated_at": "2024-05-01T12:01:00Z",
  "status": { "en": "Pending", "pt": "Pendente" },
  "substatus": { "en": "Awaiting Payment", "pt": "Aguardando Pagamento" },
  "message": {
    "en": "QR code generated; awaiting customer payment confirmation",
    "pt": "QR code gerado; aguardando confirmação de pagamento do cliente"
  },
  "error_message": { "en": "", "pt": "" },
  "attributes": {
    "quote": 5.45,
    "ref_quote": 5.30,
    "fees": 12.50,
    "currency_entry": "BRL",
    "currency_exit_received": "USDT (TRX)",
    "currency_exit_received_code": "USDT",
    "amount_payment": 550.00,
    "amount_received": 100.00,
    "pix_e2e": "E00038166202405011200...",
    "client_name": "João Silva",
    "client_tax_id": "12345678901",
    "expiration": "2024-05-01T12:30:00Z",
    "return_url": "https://yourapp.com/success",
    "external_code": "order_42",
    "webhook": "https://yourapp.com/webhooks/nox"
  }
}

{ "error": "Not Found" }

​
Path parameters

ParameterDescription
idThe end2end identifier (e.g. NOXabc123)

​
Response 200 OK

​
Attributes

FieldTypeDescription
quotefloatEffective BRL→crypto exchange rate used
ref_quotefloatMid-market reference rate at time of quote
feesfloatTotal fees charged (BRL)
currency_entrystringSource currency — always BRL
currency_exit_receivedstringDestination asset display name (e.g. USDT (TRX))
currency_exit_received_codestringDestination currency code (e.g. USDT)
amount_paymentfloatBRL amount the customer pays
amount_receivedfloatCrypto amount credited
pix_e2estringPIX end-to-end transaction ID (populated after payment)
client_namestringCustomer name
client_tax_idstringCustomer CPF or CNPJ
expirationstringISO 8601 timestamp when the session expires
return_urlstringPost-checkout redirect URL
external_codestringYour merchant reference for this checkout
webhookstringWebhook URL receiving state updates
fixed_linkstringReusable link path, if this session was created from a reusable link
404 — session not found or does not belong to your account. For all status / substatus values see Crossramp Checkout statuses. 
curl https://checkout.noxpay.io/v2/crossramp_checkout/NOXabc123 \
  -H "api-key: <key>"

import requests

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

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

{
  "end2end": "NOXabc123",
  "component": "depositpix_v2",
  "state": "QRCODE",
  "template": "crossramp_checkout",
  "created_at": "2024-05-01T12:00:00Z",
  "updated_at": "2024-05-01T12:01:00Z",
  "status": { "en": "Pending", "pt": "Pendente" },
  "substatus": { "en": "Awaiting Payment", "pt": "Aguardando Pagamento" },
  "message": {
    "en": "QR code generated; awaiting customer payment confirmation",
    "pt": "QR code gerado; aguardando confirmação de pagamento do cliente"
  },
  "error_message": { "en": "", "pt": "" },
  "attributes": {
    "quote": 5.45,
    "ref_quote": 5.30,
    "fees": 12.50,
    "currency_entry": "BRL",
    "currency_exit_received": "USDT (TRX)",
    "currency_exit_received_code": "USDT",
    "amount_payment": 550.00,
    "amount_received": 100.00,
    "pix_e2e": "E00038166202405011200...",
    "client_name": "João Silva",
    "client_tax_id": "12345678901",
    "expiration": "2024-05-01T12:30:00Z",
    "return_url": "https://yourapp.com/success",
    "external_code": "order_42",
    "webhook": "https://yourapp.com/webhooks/nox"
  }
}

{ "error": "Not Found" }