結帳

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

Tokenz Checkout 是一個預構建的支付表單，允許企業在網上安全地接受付款。結帳內建的功能可讓您減少開發時間。您可以通過將客戶轉址到託管的支付頁面來接受付款。

您可以使用 Checkout Session API (結帳工作階段 API) 自定義結帳並訪問額外的功能。

金額格式： API 中所有貨幣值（如 amount 欄位）均以各貨幣的最小單位表示。請參閱支援的貨幣以了解每種貨幣的確切編碼。

結帳流程

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 參數中發送一個或多個支援的選項，以指定向客戶提供的支付方式。如果未包括該參數或發送了空列表，則會顯示所有支援的支付方式。