Consultar Checkout

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://seuapp.com/sucesso",
    "external_code": "order_42",
    "webhook": "https://seuapp.com/webhooks/nox"
  }
}

{ "error": "Not Found" }

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://seuapp.com/sucesso",
    "external_code": "order_42",
    "webhook": "https://seuapp.com/webhooks/nox"
  }
}

{ "error": "Not Found" }

Parâmetros de caminho

Parâmetro	Descrição
`id`	O identificador `end2end` (ex: `NOXabc123`)

Response `200 OK`

Attributes

Campo	Tipo	Descrição
`quote`	float	Taxa de câmbio BRL→cripto efetiva utilizada
`ref_quote`	float	Taxa de referência mid-market no momento da cotação
`fees`	float	Total de tarifas cobradas (BRL)
`currency_entry`	string	Moeda de origem — sempre `BRL`
`currency_exit_received`	string	Nome exibido do ativo de destino (ex: `USDT (TRX)`)
`currency_exit_received_code`	string	Código da moeda de destino (ex: `USDT`)
`amount_payment`	float	Valor em BRL pago pelo cliente
`amount_received`	float	Valor em cripto creditado
`pix_e2e`	string	ID end-to-end da transação PIX (preenchido após o pagamento)
`client_name`	string	Nome do cliente
`client_tax_id`	string	CPF ou CNPJ do cliente
`expiration`	string	Timestamp ISO 8601 de expiração da sessão
`return_url`	string	URL de redirecionamento pós-checkout
`external_code`	string	Referência do lojista para este checkout
`webhook`	string	URL de webhook recebendo atualizações de estado
`fixed_link`	string	Caminho do link reutilizável, se esta sessão foi criada a partir de um link reutilizável

404 — sessão não encontrada ou não pertence à sua conta. Para todos os valores de status / substatus veja Statuses do Crossramp Checkout.

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://seuapp.com/sucesso",
    "external_code": "order_42",
    "webhook": "https://seuapp.com/webhooks/nox"
  }
}

{ "error": "Not Found" }

Criar Checkout Listar Checkouts

​Parâmetros de caminho

​Response 200 OK

​Attributes

Parâmetros de caminho

Response `200 OK`

Attributes