集成 Apple Pay 支付
通过 Apple Pay 服务,买家可以使用存储在其 Apple Pay 账户中的信用卡或借记卡进行支付。借助 Antom Checkout Page,您无需额外集成 Apple Pay 的 SDK,Checkout Page 将会为您加载 Apple Pay 服务,并支持将 Apple Pay 配置为极速支付方式。
用户体验
集成准备
- Antom 为您提供预置的 Apple Pay 商户认证,方便您快速集成。请按照以下步骤进行认证:
- 将您用于接收支付的服务器域名
DOMAIN_NAME提供给 Antom 技术专员。 - 联系 Antom 技术专员获取 Apple Pay 的域名验证文件,并将该文件放置在以下服务器目录中:
https://[DOMAIN_NAME]/.well-known/apple-developer-merchantid-domain-association在您开始集成前,请阅读集成指南及接口概述文档,了解服务端接口的集成步骤及调用接口的注意事项,并确保已完成以下预配置:
- 已获得 client ID。
- 已完成密钥配置。
- 已完成异步通知接收地址的配置。
- 集成服务端 SDK 资源包,并完成接口库安装及请求示例初始化。具体操作请参阅服务端 SDK。
- 参阅 Web/WAP 端集成 SDK 资源包文档来集成客户端 SDK 资源包,并注意使用最新或不低于 1.41.0 版本的 SDK。
集成步骤
请按照以下步骤开始集成:
- 创建支付会话
- 嵌入 Antom Checkout Page
- 获取支付结果
- 请款
步骤 1:创建支付会话
按照步骤 1:创建支付会话的步骤调用 createPaymentSession(单笔支付)接口并传入订单信息,创建支付会话后跳转至 Antom Checkout Page。同时,您还需要在请求中传入以下参数:
类型 | 字段 | 是否必需 | 描述 |
订单参数 | order.buyer | 是 | 商户端买家信息。至少需要提供以下三者其中一个信息:
|
设置 Apple Pay 的相关参数 | availablePaymentMethod.paymentMethodMetaData.applePayConfiguration | 否 | 在 Checkout Page 场景下,该参数建议使用缺省值。
|
| 指定 Apple Pay 为极速支付方式 | availablePaymentMethod.paymentMethodTypeList.expressCheckout | 否 | 您可以通过设置该参数的值为 |
以下代码展示了一个请求报文的示例:
{
"order": {
"buyer": {
"referenceBuyerId": "yourBuyerId"
},
"goods": [
{
"goodsBrand": "Antom Brand",
"goodsCategory": "outdoor goods/bag",
"goodsImageUrl": "https://mdn.alipayobjects.com/portal_pdqp4x/afts/file/A*H8M9RrxlArAAAAAAAAAAAAAAAQAAAQ",
"goodsName": "Classic Woman Bag",
"goodsQuantity": "1",
"goodsSkuName": "Black",
"goodsUnitAmount": {
"currency": "SGD",
"value": "6000"
},
"goodsUrl": "https://yourGoodsUrl",
"referenceGoodsId": "yourGoodsId"
}
],
"orderAmount": {
"currency": "SGD",
"value": "6000"
},
"orderDescription": "antom ckp testing order",
"referenceOrderId": "c3df9b82-ff67-424b-880b-06c3615b46ea"
},
"paymentAmount": {
"currency": "SGD",
"value": "6000"
},
"availablePaymentMethod": {
"paymentMethodTypeList": [
{
"paymentMethodType": "APPLEPAY",
"expressCheckout": true,
"paymentMethodOrder": 0
}
]
},
"paymentNotifyUrl": "http://www.yourNotifyUrl.com/payment/receiveNotify",
"paymentRedirectUrl": "http://localhost:8080/index.html?paymentRequestId=597795b7-c812-4132-bd7d-c55914eefdcb",
"paymentRequestId": "597795b7-c812-4132-bd7d-c55914eefdcb",
"productCode": "CASHIER_PAYMENT",
"productScene": "CHECKOUT_PAYMENT"
}步骤 2:嵌入 Antom Checkout Page
SDK 是用于处理支付流程的组件,为了收集信息以及根据 createPaymentSession(单笔支付)接口中指定的支付方式在应用间切换,您需要通过创建支付会话来启动 SDK,具体操作请参阅步骤 2:嵌入 Antom Checkout Page。
步骤 3:获取支付结果
在买家完成支付或支付超时后,您可以接收来自 Antom 的异步通知或通过主动查询来获取支付结果,具体步骤请参阅异步通知处理和查询交易。
步骤 4:请款
支付成功后,Antom 默认自动为您请款,同时支持您手动发起请款。请款后,您可以通过异步通知或主动查询来获取请款结果,您需要根据请款结果来决定是否发货。具体操作请参阅请款。
支付后操作
完成支付后,您可对交易进行以下支付后的操作:
退款
若您需要了解 Antom 的退款规则及如何对成功的交易发起退款,详情请参见退款。
争议
若买家选择使用卡支付方式,会涉及到争议相关的集成,详情请参见争议。
对账
交易完成后,使用 Antom 提供的财务报告进行对账。有关如何对账和 Antom 结算规则的更多信息,请参阅对账。
更多内容
卡支付特性
卡支付特性同样适用于 Apple Pay,以下列举了卡支付特性在 Apple Pay 的支持情况:
类型 | 是否支持 | 说明 |
条件支持 |
| |
| 卡信息存档交易(COF) | 条件支持 | 仅 MIT(商户发起交易)场景支持。 |
| 3D Secure 2 | 支持 | Apple Pay 在完成 3D Secure 2 认证后,会将加密的交易凭证(Cryptogram)和电子商业指示器(ECI)传递至 Antom。Antom 将遵循第三方卡组织的标准流程处理这些认证信息,详情请参阅 Apple Developer: Payment token format reference。因此,Checkout Page 上不会再次出现由支付方式发起的 3DS 认证流程,用户体验无缝衔接。建议您在发起支付请求时,使用 is3DSAuthentication 和 enableAuthenticationUpgrade 参数的默认值。 |
| Antom 3DS-Retry | 支持 | 无。 |
| 商户发起交易(MIT) | 支持 | 无。 |
不支持 | 无。 |
指定支付方式
您可以在 Antom Dashboard 的 支付 > 收银台设置 > 支付方式 中配置指定支付方式。您也可以通过在 接口传入参数,指定在 createPaymentSession(单笔支付)Checkout Page 上展示的支付方式、支付方式列表的排序,以及极速支付方式的展示。
注意:如果您通过接口传入参数来指定支付方式,则优先取接口传值。
此功能为您带来以下优势:
- 根据您的业务地区过滤当地的支付方式
- 按照您的偏好对支付方式进行排序
- 可以将主流的支付方式如 Alipay、Apple Pay、Google Pay 以极速支付的形式展示
要指定 Apple Pay 为唯一支付方式,请在 createPaymentSession(单笔支付)接口的 availablePaymentMethod 参数中,传入以下参数:
以下是指定 Apple Pay 为唯一支付方式的示例代码:
{
"availablePaymentMethod": {
"paymentMethodTypeList": [
{
"paymentMethodType": "APPLEPAY",
"expressCheckout": true,
"paymentMethodOrder": "0"
}
]
}
}