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可以帮助您在发起支付前完成资产绑定流程 


入参

paymentMethodType String  REQUIRED

支付方式类型包含在支付方式选项中。有关卡支付的有效值,请参见支付方式

更多信息:

  • 最大长度:64 字符

vaultingRequestId String  REQUIRED

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

更多信息:

  • 此为幂等字段。
  • 最大长度:64 字符

vaultingNotificationUrl String  REQUIRED

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

更多信息:

  • 最大长度:2048 字符

passThroughMetadata string  

一组键值对,用于指示与交易相关的附加和自定义信息。

注意:如果您希望向收单机构提供有关交易的更多信息,请指定此参数。

更多信息:

  • 最大长度:2048 字符

出参

result Result  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
请求体

响应

响应体


结果码

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

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

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

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

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

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

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

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