List checkout sessions
The account's checkouts, newest first. With an API key, those of its mode; when logged in, name the mode.
Authorization
ApiKey AuthorizationBearer <token>
A merchant API key, sent as Authorization: Bearer vk_live_…. The prefix
selects the mode: vk_test_ for testnets, vk_live_ for real money.
In: header
Query Parameters
status?string
Value in
- "open"
- "awaiting_payment"
- "detected"
- "confirming"
- "paid"
- "underpaid"
- "overpaid"
- "expired"
- "refund_due"
- "settled"
limit?integer
How many to return, newest first.
Range
1 <= value <= 100Default
20cursor?string
The next_cursor of the page before, for the page after it.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/checkout_sessions"{ "object": "list", "data": [ { "object": "checkout_session", "id": "string", "livemode": true, "url": "http://example.com", "status": "open", "invoice": "string", "customer": "string", "customer_email": "string", "amount": "string", "currency": "usd", "description": "string", "payment": { "source": "string", "asset": "USDT", "network": "tron", "amount_due": "string", "withdraw_amount": "string", "rate": "string", "expires_at": "2019-08-24T14:15:22Z" }, "amount_received": "string", "payments": [ { "object": "payment", "id": "string", "checkout_session": "string", "asset": "USDT", "network": "tron", "amount": "string", "status": "detected", "tx_hash": "string", "detected_at": "2019-08-24T14:15:22Z", "confirmed_at": "2019-08-24T14:15:22Z" } ], "success_url": "string", "cancel_url": "string", "expires_at": "2019-08-24T14:15:22Z", "paid_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" } ], "has_more": true, "next_cursor": "string"}