跳转到主要内容

​
概述

结账会话链接通过 POST Session API 动态生成。该 API 返回一个有时效性的链接，指向预填充了客户信息的 Clink 托管结账页面。我们建议为每次客户支付意向创建一个新的会话。 每个结账会话可以进行多次支付尝试，直到完成一笔成功的交易。成功的交易可以是一次性购买或订阅。

​
会话数据

​
状态

  • 开放：结账会话已创建但尚未收到成功支付
  • 完成：结账会话已通过成功支付完成
  • 过期：结账会话已过期，不允许进行更多支付尝试

​
产品和价格

如果你已在控制台配置了产品和价格，你可以直接使用它们的 ID 进行引用。对于基于订阅的循环付款，必须预先创建产品。 对于一次性购买的产品，你可以在 priceDataList 中定义产品详情（名称、单价、数量等）。结账会话将相应显示这些产品详情。

​
客户

结账会话包含预填充的客户信息。如果客户之前通过控制台或 API 创建，你可以使用其客户 ID 进行引用。对于新客户，只需提供其电子邮件地址，Clink 将自动创建客户档案。新创建的客户 ID 将包含在 API 响应中。

​
URLs

虽然是可选的，但我们强烈建议提供成功和取消 URL 用于结账后的导航。

​
Merchant Reference

Merchant Reference 作为商户内部标识符用于跟踪目的。此参考号将记录在通过结账会话创建的订单中。
幂等性：Clink 不基于 Merchant Reference ID 维护幂等性。
这些 ID 仅用于将会话与你的内部系统进行对账。使用相同 Merchant Reference ID 创建的多个结账会话将被视为不同的会话。

​
返回 URL

当在创建结账会话时提供了成功 URL，Clink 将在支付成功后将客户重定向到指定地址。 在重定向过程中，Clink 会将 Session ID 作为 URL 参数附加，使你能够通过 Session#Get API 查询会话数据。 返回 URL 示例：
  • https://your_success_url.com?sessionId=sess_randoms
  • https://your_success_url.com?custom=xxxxxxxx&sessionId=sess_randoms

​
客户体验

Clink 希望提供一个自适应、高效且标准化的结账体验解决方案。虽然定制选项有限，但界面保持简洁专业的设计。 商户信息和取消 URL 可从左上角访问。产品和价格信息基于 dashboard 配置或 API 输入显示。 可用的支付方式和货币会根据以下因素自动调整：
  • 购买类型（一次性或订阅）
  • 客户的地理位置

​
快速入门示例

参考以下代码片段快速开始：
在部署到生产环境之前，请务必充分测试你的代码！
curl --location --request POST 'https://api.clinkbill.com/api/checkout/session' \
--header 'X-Timestamp: ${currentMillisecondsTimestamp}' \
--header 'X-API-Key: ${sk_key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerEmail": "customer@example.com",
    "originalAmount": ${amount},
    "originalCurrency": "USD",
    "priceDataList":[
        {
            "name":"一次性购买",
            "quantity": 1,
            "unitAmount":${unitAmount},
            "currency":"USD"
        }
    ]
}'