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

notifyUpdate

Alipay uses the notifyUpdate interface to send the settlement information update result to the marketplace when the update reaches a final state of success or failure.

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

notifyType String  REQUIRED

The notification type about settlement information update. The value of this parameter is fixed to SETTLEMENT_INFO_UPDATE_RESULT.  

More information:

  • Maximum length: 64 characters

referenceMerchantId String  REQUIRED

The unique ID that is assigned by the marketplace to identify the seller. 

More information:

  • Maximum length: 64 characters

updateRequestId String  REQUIRED

The unique ID that is assigned by the marketplace to identify an update request for settlement information.  

More information:

  • Maximum length: 64 characters

updateStatus String  REQUIRED

The update status of the settlement information. Valid values are:

  • SUCCESSFUL: indicates that the settlement information update status is successful.
  • FAILED: indicates that the settlement information update status is failed.
  • PROCESSING: indicates that the settlement information update status is processing.  

More information:

  • Maximum length: 64 characters

reasonCode String  

The reason code of a failed settlement information update. Valid values are: REJECT_FOR_RISK, CONTRACT_NOT_FOUND, and UPDATE_FAILED.

This parameter is returned when the value of updateStatus is FAILED.  

More information:

  • Maximum length: 64 characters

reasonMessage String  

The message of reasonCode. Descriptions for different reason codes are as follows:

  • REJECT_FOR_RISK: The settlement information update is rejected because of risk control.
  • CONTRACT_NOT_FOUND: The contract that requires an update of the settlement information is not found.
  • UPDATE_FAILED: The settlement information update failed because of uncertain reasons. Contact Alipay Technical Support for detailed reasons.

This parameter is returned when the value of updateStatus is FAILED.  

More information:

  • Maximum length: 256 characters

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

Result processing logic

Send the following message with fixed values to Alipay after receiving the notification, to acknowledge that the notification from Alipay is received:

Sample Code

If no such message is returned to Alipay due to operation issues or network issues, Alipay will send the notification again and again until the required message is returned by the merchant. Resending of the notification will be performed within 24 hours after the first notification is sent. The notification will be resent up to eight times, with an interval of 0s, 2min, 10min, 10min, 1h, 2h, 6h, and 15h.