Skip to content
列出收银台会话

GET /v1/checkout/sessions

GET
/v1/checkout/sessions

Lists sessions for the authenticated merchant, with optional filtering.

授权

bearer_auth

API key authentication. Use sk_test_... for sandbox or sk_live_... for production.

类型
HTTP (bearer)

参数

查询参数

page

Page number (default: 1)

类型
integer
格式
"int64"
最小值
0
page_size

Items per page (default: 20, max: 100)

类型
integer
格式
"int64"
最小值
0
search_text

Search by session ID, tx hash, or pay address

类型
string
status

Filter by status (e.g. Pending, Paid, Expired). Supports multiple values via repeated parameter.

类型
string
network

Filter by network (e.g. TRON, BSC, ETHEREUM)

类型
string
created_after

Filter sessions created after this ISO 8601 datetime

类型
string
created_before

Filter sessions created before this ISO 8601 datetime

类型
string
include_sub_merchants

Include sub-merchant sessions in results

类型
boolean
sub_merchant_code

Filter to a specific sub-merchant code

类型
string

响应

Paginated sessions

application/json
JSON
[
  
{
  
  
"amount": "10.5",
  
  
"amount_received": "10.5",
  
  
"cancel_url": "https://example.com/cancel",
  
  
"chain_family": "string",
  
  
"client_reference_id": "order_20260211_001",
  
  
"created_at": "2026-02-11T03:56:00Z",
  
  
"currency": "USDT",
  
  
"currency_contract": "string",
  
  
"detection_rpc_url": "string",
  
  
"expires_at": "2026-02-11T04:26:00Z",
  
  
"fee_amount": "1",
  
  
"id": "cs_abc123def456",
  
  
"livemode": false,
  
  
"merchant_logo_url": "string",
  
  
"merchant_name": "Acme Store",
  
  
"net_amount": "9.5",
  
  
"network": "TRON",
  
  
"pay_address": "TQFEyGNzHZAJmebJUvsoZvJghHm2yNhXAD",
  
  
"pricing": {
  
  
  
"amount": "10.50",
  
  
  
"currency": "USD",
  
  
  
"exchange_rate": "1.00000000"
  
  
},
  
  
"status": "string",
  
  
"sub_merchant_code": "shop_tokyo",
  
  
"success_url": "https://example.com/success",
  
  
"transactions": [
  
  
  
{
  
  
  
  
"amount": "10.5",
  
  
  
  
"created_at": "2026-02-11T03:56:00Z",
  
  
  
  
"network": "TRON",
  
  
  
  
"status": "Confirmed",
  
  
  
  
"tx_hash": "8d490254caa24a5ff0b6522976a52d90d0e0fc4187dd78659ea2b78236fc8afc"
  
  
  
}
  
  
],
  
  
"url": "https://checkout.ironixpay.com/cs_abc123def456"
  
}
]

试验场

服务器
授权
变量

示例

技术支持 VitePress OpenAPI