结账

了解如何使用 Checkout 在您的网站上收款。

Tokenz Checkout 是一个预构建的支付表单，允许企业在线安全地接受付款。Checkout 内置的功能可帮助您缩短开发时间。您可以通过将客户引导到托管的支付页面来接受付款。

您可以使用 Checkout Session API (结账会话 API) 自定义 Checkout，并访问更多功能。

金额格式： API 中所有货币值（如 amount 字段）均以各货币的最小单位表示。请参阅支持的货币了解每种货币的确切编码。

Checkout 生命周期

1. 客户在您的网站上选择商品并点击结账。
2. 您的服务器使用 Tokenz API 创建新的 Checkout Session。
3. Tokenz API 返回 Checkout Session。
4. 您的服务器将客户重定向到 Tokenz 托管的支付页面。
5. 客户在 Tokenz 托管的支付页面完成付款。
6. Tokenz 将客户重定向回您的网站。
7. Tokenz 向您的服务器发送 Webhook 事件。
8. 您的服务器使用 order.succeeded 事件履行订单。

Checkout Session

Checkout Session (结账会话) 是客户在支付表单上看到的内容的程序表示。在创建 Checkout Session 后，将您的客户重定向至 url 以完成购买。当客户完成购买后，您可以通过配置订单事件的 Webhook 来履行订单。以下代码片段展示了如何在您的应用程序中创建结账会话。

curl --request POST \
  --url https://api.tokenz.one/v2/checkoutsession \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer secret_test_YOUR_KEY_HERE' \
  --data '{
    "itemDetails": [
      {
        "product": {
          "price": {
            "amount": 1000,
            "currency": "JPY"
          },
          "images": [
            "https://images.ctfassets.net/z82qbo7cv7ia/6LaDyyNBQ5Sqd1THQYxksI/ff5bce84e3864a4f826f5aed0822bd10/treasure-chest-1.png"
          ],
          "quantity": 1,
          "label": "Treasure Chest",
          "taxCategory": "DIGITAL_GOODS_AND_SERVICES"
        }
      }
    ],
    "successUrl": "https://example.com/success",
    "pendingUrl": "https://example.com/pending",
    "cancelUrl": "https://example.com/cancel",
    "customerInfo": {}
  }'

订单总额始终根据 itemDetails 中的价格计算。部分示例中出现的顶层 amount 字段为可选项，但如果提供该字段，其值必须与 itemDetails 的总额一致，否则请求将被拒绝。

税务类别

为确保正确的税务计算和合规性，结账会话中的每个商品都必须包含 taxCategory 字段。支持以下类别：

• VIRTUAL_CURRENCY: 游戏内货币、代币或虚拟硬币
• DIGITAL_GOODS_AND_SERVICES: 数字产品，如游戏道具、可下载内容或数字服务
• EBOOK: 电子书籍和出版物
• SAAS: 软件即服务订阅

请选择最符合您产品类型的类别，以确保准确的税务处理。

支付方式

您可以自定义在托管的支付页面上向您的客户提供的支付方式。在 paymentMethodKinds 参数传递一个或多个支持的选项，以指定向客户提供的支付方式。如果未包含该参数或传递了空列表，则会展示所有支持的支付方式。