inquireVaulting
Use the inquireVaulting API to inquire about the vaulting status of a payment method.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:
- If the data type of a field is Integer and its value is 20, set it as "20".
- If the data type of a field is Boolean and its value is
true, set it as "true".
Request parameters
vaultingRequestId String REQUIRED
The unique ID that is assigned by a merchant to identify a card vaulting request.
More information about this field
- This field is an API idempotency field. For vaulting requests that are initiated with the same value of vaultingRequestId and reach a final status of
SorF, the same result is to be returned for the request.
More information about this field
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
Information about the request calling result.
This field does not indicate the vaulting result. This field only indicates whether this interface is called successfully.
vaultingRequestId String REQUIRED
The unique ID that is assigned by a merchant to identify a card vaulting request.
More information about this field
- Maximum length: 64 characters
normalUrl URL
The URL that redirects users to a WAP or WEB page in the default browser or the embedded WebView.
When the value of result.resultStatus is S and the value of vaultingStatus is PROCESSING, one or more of the following URLs may be returned: schemeUrl, applinkUrl, and normalUrl.
When the value of paymentMethodType is CARD, the user is required to complete the 3DS authentication on the page accessed through this URL.
More information about this field
- Maximum length: 2048 characters
schemeUrl URL
The URL scheme that redirects users to open an App in an Android or iOS system when the target App is installed.
When the value of result.resultStatus is S and the value of vaultingStatus is PROCESSING, one or more of the following URLs may be returned: schemeUrl, applinkUrl, and normalUrl.
More information about this field
- Maximum length: 2048 characters
applinkUrl URL
The URL that redirects users to open an app when the target app is installed, or to open a WAP page when the target app is not installed. For Android, the URL is a Native App Link. For iOS, the URL is a Universal Link.
When the value of result.resultStatus is S and the value of vaultingStatus is PROCESSING, one or more of the following URLs may be returned: schemeUrl, applinkUrl, and normalUrl.
More information about this field
- Maximum length: 2048 characters
paymentMethodDetail PaymentMethodDetail object
The details about the payment method that needs to be vaulted.
This parameter is returned when the value of vaultingStatus is SUCCESS.
vaultingStatus String
Indicates the payment method's vaulting status. Valid values are:
SUCCESS: indicates that the vaulting is successful.FAIL: indicates that the vaulting failed.PROCESSING: indicates that the vaulting is under process.
This parameter is returned when the value of result.resultStatus is S.
More information about this field
- Maximum length: 10 characters
Request
Response
Result process logic
For different request results, different actions must be taken. The possible responses for result.resultStatus are:
S: indicates the API call succeeded. You can get the vaulting result from vaultingStatus in the API response.F: indicates the API call failed. For more information on why the call failed, see result.resultCode.U: indicates the API call failed due to an unknown reason. Retry using the same request ID.
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| VAULTING_NOT_EXIST | F | The vaulting request ID does not exist. | Check whether the value of vaultingRequestId is correct. If it is correct, contact Alipay Technical Support for specific reasons. |
| UNKNOWN_EXCEPTION | U | An API call has failed, which is caused by unknown reasons. | Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. |