Antom, leading provider of tailored payment solutions

inquireVaulting

POST /v1/vaults/inquireVaulting
使用此接口查询支付方式的绑定状态。 

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:
注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:
  • 如果字段的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果字段的数据类型为布尔属性,且其值为 true,设置为 "true"。

入参

vaultingRequestId String  REQUIRED

由商户生成的用于标识绑卡请求的专属 ID。
注意:此字段是幂等字段。对于使用相同 vaultingRequestId 值发起并达到最终状态S或F的资产绑定请求,应返回相同的结果。

更多信息:

  • 最大长度:64 字符

出参

result Result  REQUIRED

请求调用结果的信息。 
此字段不表示资产绑定结果。此字段仅表示该接口是否调用成功。 

vaultingRequestId String  REQUIRED

由商户生成的用于标识绑卡请求的专属 ID。

更多信息:

  • 最大长度:64 字符

normalUrl URL  

将用户跳转到默认浏览器或嵌入式 WebView 中的 WAP 或 WEB 页面的链接。
注意:
  • 当 result.resultStatus 的值为 S 且 vaultingStatus 的值为 PROCESSING 时,可能会返回以下一个或多个链接:schemeUrl、applinkUrl 和 normalUrl。  
  • 当 paymentMethodType 的值为 CARD 时,买家需要通过此链接访问的页面完成 3DS 验证。  

更多信息:

  • 最大长度:2048 字符

schemeUrl URL  

应用安装完成后,用于在 Android 或 iOS 系统中打开应用的 URL scheme。
注意:当 result.resultStatus 的值为S且 vaultingStatus 的值为PROCESSING时,可能会返回以下一个或多个链接:schemeUrl、applinkUrl 和 normalUrl。  

更多信息:

  • 最大长度:2048 字符

applinkUrl URL  

应用安装完成后,用于引导用户打开应用的链接,或者安装失败时,用于打开 WAP 页面的链接。对于 Android,该链接是 Native App Link。对于iOS,该链接是 Universal Link。
注意:当 result.resultStatus 的值为S且 vaultingStatus 的值为PROCESSING时,可能会返回以下一个或多个链接:schemeUrl、applinkUrl 和 normalUrl。

更多信息:

  • 最大长度:2048 字符

paymentMethodDetail PaymentMethodDetail  

要绑定的支付方式的详细信息。
注意:当 vaultingStatus 的值为 SUCCESS 时,返回此参数。

vaultingStatus String  

表示支付方式的绑定状态。有效值为:
  • SUCCESS: 表示绑定成功。 
  • FAIL: 表示绑定失败。
  • PROCESSING: 表示绑定处理中。 
注意:当 result.resultStatus 的值为 S 时返回此参数。  

更多信息:

  • 最大长度:10 字符

acquirerInfo AcquirerInfo  

收单机构信息。
API Explorer

请求

URL
Method
POST
json
{
  "vaultingRequestId": "12345678****"
}

响应

json
{
  "acquirerInfo": {
    "acquirerName": "ADYEN"
  },
  "paymentMethodDetail": {
    "card": {
      "brand": "VISA",
      "supportedBrands": [
        "VISA",
        "MASTERCARD"
      ],
      "cardToken": "ALIPAY9CGwsAeMBug+G2dSKDV6AIsNKTxAFNkOMoj8Gxvt8h0eDUbd6nO5CwMFIjEFERWxCAo/b1OjVTvtl1zspyMGcg==",
      "maskedCardNo": "************8764",
      "networkTransactionId": "xxxxx"
    },
    "paymentMethodType": "CARD"
  },
  "vaultingRequestId": "123487889889",
  "vaultingStatus": "SUCCESS",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  }
}

结果处理逻辑

对于不同的请求结果,需要采取不同的行动。result.resultStatus 可能的响应包括:
  • S: 表示接口调用成功。您可以通过接口响应中的 vaultingStatus 获取资产绑定结果。
  • F: 表示接口调用失败。有关失败原因的更多信息,请参阅 result.resultCode。
  • U: 表示由于未知原因接口调用失败。使用相同的请求 ID 重试。 

结果码

结果码值结果码信息行动建议
SUCCESSS成功
接口调用成功,无需进一步操作。
VAULTING_NOT_EXISTF资产绑定请求 ID 不存在。
请检查 vaultingRequestId 的值是否正确。如果正确,请联系 APO 技术支持以获取具体原因。 
UNKNOWN_EXCEPTIONU由于未知原因,接口调用失败。
重新调用接口以解决问题。如果问题未解决,请联系 APO 技术支持。