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();
{
"version": "v2",
"end2end": "NOXabc123",
"created_at": "2024-05-01T12:00:00Z",
"updated_at": "2024-05-01T12:01:00Z",
"process": "pix_deposit.awaiting_payment",
"status": { "en": "Pending", "pt": "Pendente", "es": "Pendiente" },
"substatus": { "en": "Awaiting Payment", "pt": "Aguardando Pagamento", "es": "Esperando Pago" },
"message": { "en": "QR code generated; awaiting customer payment confirmation", "pt": "QR code gerado; aguardando confirmação de pagamento do cliente", "es": "Código QR generado; esperando confirmación de pago del cliente" },
"error_message": { "en": "", "pt": "", "es": "" },
"attributes": {
"quote": 5.45,
"ref_quote": 5.30,
"fees": 12.50,
"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": "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"
}
}
Crossramp Checkout
Get Checkout
GET /v2/crossramp_checkout/ — retrieve a single Crossramp Checkout session by its end2end ID.
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();
{
"version": "v2",
"end2end": "NOXabc123",
"created_at": "2024-05-01T12:00:00Z",
"updated_at": "2024-05-01T12:01:00Z",
"process": "pix_deposit.awaiting_payment",
"status": { "en": "Pending", "pt": "Pendente", "es": "Pendiente" },
"substatus": { "en": "Awaiting Payment", "pt": "Aguardando Pagamento", "es": "Esperando Pago" },
"message": { "en": "QR code generated; awaiting customer payment confirmation", "pt": "QR code gerado; aguardando confirmação de pagamento do cliente", "es": "Código QR generado; esperando confirmación de pago del cliente" },
"error_message": { "en": "", "pt": "", "es": "" },
"attributes": {
"quote": 5.45,
"ref_quote": 5.30,
"fees": 12.50,
"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": "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"
}
}
Path parameters
| Parameter | Description |
|---|---|
id | The end2end identifier (e.g. NOXabc123), or the pix_e2e of the payment |
{id} does not match an end2end, it is retried against the Pix end-to-end ID, so you can look a session up either way on the same route with no extra parameter.
Response 200 OK
Attributes
| Field | Type | Description |
|---|---|---|
quote | float | Effective BRL→crypto exchange rate used |
ref_quote | float | Mid-market reference rate at time of quote |
fees | float | Total fees charged (BRL) |
currency_entry | string | Source currency — always BRL |
currency_exit_received | string | Destination asset display name (e.g. USDT (TRX)) |
currency_exit_received_code | string | Destination currency code (e.g. TRX_USDT_S2UZ) |
amount_payment | float | BRL amount the customer pays |
amount_received | float | Crypto amount credited |
pix_e2e | string | PIX end-to-end transaction ID (populated after payment) |
client_name | string | Customer name |
client_tax_id | string | Customer CPF or CNPJ |
expiration | string | ISO 8601 timestamp when the session expires |
return_url | string | Post-checkout redirect URL |
external_code | string | Your merchant reference for this checkout |
webhook | string | Webhook URL receiving state updates |
fixed_link | string | Reusable link path, if this session was created from a reusable link |
pix_e2e before payment, for instance — means that step has not happened yet.
404 — session not found or does not belong to your account. The two cases are deliberately indistinguishable.
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();
{
"version": "v2",
"end2end": "NOXabc123",
"created_at": "2024-05-01T12:00:00Z",
"updated_at": "2024-05-01T12:01:00Z",
"process": "pix_deposit.awaiting_payment",
"status": { "en": "Pending", "pt": "Pendente", "es": "Pendiente" },
"substatus": { "en": "Awaiting Payment", "pt": "Aguardando Pagamento", "es": "Esperando Pago" },
"message": { "en": "QR code generated; awaiting customer payment confirmation", "pt": "QR code gerado; aguardando confirmação de pagamento do cliente", "es": "Código QR generado; esperando confirmación de pago del cliente" },
"error_message": { "en": "", "pt": "", "es": "" },
"attributes": {
"quote": 5.45,
"ref_quote": 5.30,
"fees": 12.50,
"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": "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"
}
}