Get & List Checkouts

GET /v2/crossramp_checkout/ and GET /v2/crossramp_checkouts — retrieve a single session or list all sessions.

Get a single checkout

GET /v2/crossramp_checkout/{id}
Authorization: Bearer <your-api-key>

Path parameters

Parameter	Description
id	The end2end identifier (e.g. NOXabc123)

Response 200 OK

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

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. USDT)
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	Static link path, if created from a static link

404 — session not found or does not belong to your account.

For all status / substatus values see Crossramp Checkout statuses.

---

List checkouts

GET /v2/crossramp_checkouts
Authorization: Bearer <your-api-key>

Query parameters

Parameter	Type	Description
limit	integer	Max results per page (default: 20, max: 100)
offset	integer	Pagination offset (default: 0)
pix_e2e	string	Filter by PIX end-to-end transaction ID
client_tax_id	string	Filter by customer CPF or CNPJ
date_from	string	Start date filter — YYYY-MM-DD
date_to	string	End date filter — YYYY-MM-DD

Response 200 OK

{
  "version": "v2",
  "total": 42,
  "limit": 20,
  "offset": 0,
  "results": [ ]
}

Each item in results has the same shape as the single GET response.