Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

资产绑定会话创建

POST /v1/vaults/createVaultingSession

使用此接口创建一个资产绑定会话，以集成客户端 SDK。Antom 会通过此接口响应返回加密的会话数据。然后，您可以使用这些会话数据启动客户端 SDK。SDK 会在简化绑卡流程后发起支付。 

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：


注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

  • 如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
  • 如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。

入参

paymentMethodType String  REQUIRED

被绑定的支付方式类型。 该参数的值设置为CARD。

更多信息：

  • 最大长度：64 字符

vaultingRequestId String  REQUIRED

商户为绑卡请求分配的专属 ID。 

更多信息：

  • 此为幂等字段。对于使用相同 vaultingRequestId 发起并且最终状态为S或F的资产绑定请求，应返回相同的结果。
  • 最大长度：64 字符

vaultingNotificationUrl String  REQUIRED

接收资产绑定结果通知的链接。 

更多信息：

  • 最大长度：2048 字符

redirectUrl String  

绑卡完成后，买家被重定向到的商户页面链接。 

注意：如果希望在绑卡完成后直接将买家重定向到您的页面，请指定此参数。

更多信息：

  • 最大长度：2048 字符

merchantRegion String  

商户经营业务的国家或地区。此参数的值基于 ISO 3166 国家代码标准的二位字母国家或地区代码。

可能的值包括 US, SG, HK, PK, JP, CN, BR, AU, 和 MY。

注意：在使用全球收单网关（GAGW）产品时指定此参数。

更多信息：

  • 最大长度：2 字符

出参

result Result object REQUIRED

接口调用的结果。 

Show child parameters

vaultingSessionData String  REQUIRED

加密的资产绑定会话数据。将数据传递给前端以初始化客户端 SDK。 

更多信息：

  • 最大长度：4096 字符

vaultingSessionId String  REQUIRED

Antom 为识别资产绑定会话而分配的加密 ID。 

更多信息：

  • 最大长度：64 字符

vaultingSessionExpiryTime Datetime  REQUIRED

资产绑定会话过期的具体日期和时间。 

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。
API Explorer
示例代码沙箱运行

请求

URL

请求体

响应

响应体

结果处理逻辑 

在调用接口后，Antom 会返回接口调用的结果。对于result.resultStatus 可能的响应包括：

  • S: 表示接口调用成功。通过调用 绑定结果查询 接口或等待 Antom 的通知来获取支付方式的绑定状态。
  • F: 表示接口调用失败。有关失败原因的更多信息，请参阅 result.resultCode。
  • U: 表示由于未知原因接口调用失败。使用相同的请求 ID 重试。 

结果码

结果码值结果码信息行动建议
SUCCESSS成功

支付会话创建成功。无需进一步操作。

PARAM_ILLEGALF缺少必需的参数，或者存在非法参数。例如，非数字输入、无效的日期，或者参数的长度和类型错误。

检查并验证当前接口所需的请求字段（包括头部字段和正文字段）是否正确传递并有效。

PROCESS_FAILF发生了常见的业务失败。

获取 Antom 技术支持前请勿重试。

UNKNOWN_EXCEPTIONU由于未知原因，接口调用失败。

再次调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。