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

notifyVaulting

Alipay uses notifyVaulting to send the vaulting result to the merchant when the vaulting processing reaches a final state of success or failure. Merchants promote merchant-side transactions based on the vaulting result. 

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

result Result  REQUIRED

Details about the vaulting result, such as vaulting status, result code, and result message. 

Show child parameters

vaultingRequestId String  REQUIRED

The unique ID that is assigned by a merchant to identify a card vaulting request. 

More information:

  • Maximum length: 64 characters

paymentMethodDetail PaymentMethodDetail  REQUIRED

The details about the card payment method.

More information:

  • Maximum length: 64 characters
Show child parameters

vaultingCreateTime Datetime  REQUIRED

The date and time when the vault is created.

More information:

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

acquirerInfo AcquirerInfo  

The information of the acquirer that processes the payment. 

This parameter is returned if you integrate the POP product.  

Show child parameters

Response parameters

result Result  REQUIRED

A fixed value, which is sent to Alipay to acknowledge that the notification is received. 

Show child parameters
API Explorer

Request

Request Body

Response

Response Body