Get Checkout Session

GET /v1/checkout_sessions/:id

Overview

Retrieves the details of a specific checkout session using its unique identifier. This endpoint returns the session's current state, including payment details and supported tokens.

Authorization

• Header: Authorization: Bearer sk_test_907...de66

Request Details

Request

cURL

curl https://api-prod.paybytoken.io/v1/checkout_sessions/chk_test_t24ad80A4qbKRmUyfhE87SwA \
  -X GET \
  -H "Authorization: Bearer sk_test_907...de66"

Request Parameters

Parameter	Type	Description
id	string	Unique identifier of the session (e.g., chk_test_t24ad80A4qbKRmUyfhE87SwA).

Response Details

Response

The response returns a CheckoutSession object containing the session's details. See Checkout Sessions Overview for the full object definition.

Example Response

Success

{
  "id": "chk_test_t24ad80A4qbKRmUyfhE87SwA",
  "account_id": "acct_1",
  "payment_intent_id": null,
  "success_url": "https://example.com/success",
  "cancel_url": "https://example.com/cancel",
  "return_url": null,
  "url": "https://checkout.paybytoken.io/pay?session_id=chk_test_t24ad80A4qbKRmUyfhE87SwA",
  "amount_subtotal": "10",
  "amount_total": "10",
  "currency": "USD",
  "chain": null,
  "selected_token": null,
  "supported_tokens": [
    {
      "name": "USD Coin",
      "chain": "base",
      "currency": "USDC",
      "decimals": 6,
      "chain_name": "Base",
      "chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/base-logo.png",
      "contract_address": "0xBd02F04420F7bA751d6240f053E2decfb6c90821",
      "currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png"
    },
    {
      "name": "USD Coin",
      "chain": "ethereum",
      "currency": "USDC",
      "decimals": 6,
      "chain_name": "Ethereum",
      "chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/eth-logo.png",
      "contract_address": "0x1C0c0a3843f952DcD9159C9101f8E74844d92fED",
      "currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdc-logo.png"
    },
    {
      "name": "Tether USD",
      "chain": "base",
      "currency": "USDT",
      "decimals": 6,
      "chain_name": "Base",
      "chain_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/base-logo.png",
      "contract_address": "0x9EBB7f9D1cF88BBC35Bdc0c917C9B0E32640D024",
      "currency_logo_url": "https://paybytoken.oss-cn-hongkong.aliyuncs.com/token/usdt-logo.png"
    }
  ],
  "mode": "payment",
  "discounts": [],
  "line_items": [
    {
      "quantity": 2,
      "unit_amount": "5",
      "amount_total": "10",
      "product_data": {
        "name": "Gucci Authentication Course",
        "images": [
          "https://authclass-prod.oss-cn-hongkong.aliyuncs.com/20250116a056bca0d300fe8e.png"
        ],
        "description": "Become an expert in Gucci bag authentication with this comprehensive course."
      }
    }
  ],
  "status": "open",
  "customer_id": null,
  "customer_email": null,
  "csrf_token": "6d77cc3a3ec2e11bdb4a14cb7d715c5f80d51a2845fc003b543b8447aec7d0d8",
  "description": null,
  "metadata": null,
  "exchange_rate": null,
  "expired_at": "2025-09-05T14:19:56.000Z",
  "used_at": null,
  "accessed_at": null,
  "created_at": "2025-09-05T13:19:56.000Z",
  "updated_at": "2025-09-05T13:19:56.000Z"
}