资产绑定会话创建
入参
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 REQUIRED
接口调用的结果。
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 重试。
结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | 成功 |
支付会话创建成功。无需进一步操作。 |
PARAM_ILLEGAL | F | 缺少必需的参数,或者存在非法参数。例如,非数字输入、无效的日期,或者参数的长度和类型错误。 |
检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 |
PROCESS_FAIL | F | 发生了常见的业务失败。 | 获取 Antom 技术支持前请勿重试。 |
UNKNOWN_EXCEPTION | U | 由于未知原因,接口调用失败。 | 再次调用接口以解决问题。如果问题未解决,请联系 Antom 技术支持。 |