创建结账

创建新的 Afterpay 订单需要哪些 API 调用?


操作端点目的
获取配置/v2/platform/configuration获取 Afterpay 订单限额(最小/最大值)。
创建结账/v2/checkouts提供订单详情并生成结账令牌。

在创建 Afterpay 结账之前,商户需要获取 Afterpay 启用的最小和最大订单金额。这是通过获取配置端点完成的。

1. 获取配置

GET /v2/configuration

此调用应作为计划后台进程的一部分执行。我们建议每天调用一次此端点,并在服务器端存储 minimumAmountmaximumAmount

商户应使用这些值来确定:

  1. 在产品详情页面上显示正确的 Afterpay 消息
  2. 是否应将 Afterpay 作为可用的支付方式呈现。 如果订单总金额小于最小金额或大于最大 Afterpay 金额,创建结账的请求将被拒绝。请与您的 Afterpay 联系人联系以更改您的最小或最大范围。

2. 创建结账

POST /v2/checkouts

您将调用创建结账端点来向 Afterpay 提供以下信息:

  1. 客户信息
  2. 订单详情
  3. 订单总额
  4. 配送信息
  5. 您希望在客户完成 Afterpay 结账流程时将其定向到的 URL
Afterpay 使用订单总额来计算分期付款计划并协助客户的预批准流程。

Afterpay 响应一个用于标识此结账的令牌。 例如:002.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju

该令牌与 Afterpay.js JavaScript 库 一起使用,将客户引导至 Afterpay 结账流程。

Afterpay 结账最终界面 Afterpay-Checkout-final-screen

客户完成结账流程后,他们将被返回到创建结账请求中提供的商户网站 URL。如果使用重定向方法,状态将附加到商户 URL。例如:

  • 如果客户成功完成结账流程: www.merchant-example.com/confirm?&status=SUCCESS&orderToken=002.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju
  • 如果客户关闭窗口: www.merchant-example.com/confirm?&status=CANCELLED&orderToken=002.5lmerr3k945d00c7htvcrdff83q36kp10a247m212fjpa5ju

还提供了弹出窗口方法,它使用 postMessage 来传达状态和令牌。

选择何时捕获付款

现在您已经获得了结账的成功预批准,您可以直接捕获订单或创建授权 API 调用以将资金保留,直到您准备好捕获为止。