Skip to main content
GET
Get checkout session
Returns the same safe invoice payload the hosted gateway renders: amount, status, merchant display name, expiry, mode — and the deposit address once a wallet has been generated.
No API key required. This endpoint is intentionally public (it only exposes checkout-safe fields), so your own order pages can render payment status with just the payment id.

Typical uses

  • Render a “pay in progress” page on your site from the payment id you stored at creation.
  • Poll status in a merchant-owned checkout UI (prefer Webhooks as the source of truth; poll only as a fallback).
  • Confirm fulfillment server-side before shipping goods — never trust the customer’s redirect.

Field highlights

An unknown id returns 404 Payment not found. Test-mode ids don’t exist in live mode and vice versa.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Payment (checkout session) id returned on creation.

Response

Checkout session payload

Safe invoice view of a checkout session (public, no key).

id
string<uuid>
amount
string
currency
string
status
enum<string>
Available options:
pending,
completed,
expired,
cancelled
description
string | null
wallet_id
string<uuid> | null
tx_hash
string | null
created_at
string<date-time>
is_test
boolean
redirect_url
string<uri> | null
expires_at
string<date-time> | null
coin_symbol
string | null
chain
enum<string> | null
Available options:
solana,
sui,
null
processing_fee_enabled
boolean
merchant_name
string

Merchant display name.

wallet_address
string | null

One-time deposit address, once generated.

wallet_chain
string | null