update
The update API is used by the marketplace to modify the settlement information of the settlement bank account for the sub-merchant. The marketplace can get the update result through the notifyUpdate interface.
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
updateRequestId String REQUIRED
The unique ID that is assigned by the marketplace to identify an update request for settlement information. Alipay uses this field for idempotence control.
More information:
- This field is an API idempotency field.For registration requests that are initiated with the same value of registrationRequestId and reach a final status (resultStatus = S or F), the same result is to be returned for the request.
- 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
settlementCurrency String REQUIRED
The seller's settlement currency that is specified in the settlement contract. The value of this parameter is a 3-letter currency code that follows the ISO 4217 standard.
More information:
- Maximum length: 3 characters
settlementBankAccount SettlementBankAccount REQUIRED
The seller's bank account that Alipay settles to.
Response parameters
result Result
The request result, which contains information such as status and error codes.
updateStatus String
The update status of the settlement information. The value of this parameter is fixed to PROCESSING.
Get the settlement information update result from the notifyUpdate and inquireUpdate interfaces.
This parameter is returned when the value of result.resultStatus is S.
More information:
- Maximum length: 64 characters
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | The application for the settlement information update is successful. Get the settlement information update result from the notifyUpdate and inquireUpdate interfaces. |
| ACCESS_DENIED | F | Access is denied. | Contact Alipay Technical Support for detailed reasons. |
| INVALID_API | F | The called API is invalid or not active. | Contact Alipay Technical Support to resolve the issue. |
| PARAM_ILLEGAL | F | The required parameters are not passed, or illegal parameters exist. For example, a non-numeric input, an invalid date, or the length and type of the parameter are wrong. | Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid. |
| PROCESS_FAIL | F | A general business failure occurred. | Do not retry. Human intervention is usually needed. It is recommended that you contact Alipay Technical Support to troubleshoot the issue. |
| SYSTEM_ERROR | F | A system error occurred. | Do not retry, and contact Alipay Technical Support for more details. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call this interface again to resolve the issue. If not resolved, contact Alipay Technical Support. |
| UNKNOWN_EXCEPTION | U | An API call has failed, which is caused by unknown reasons. | Call this interface again to resolve the issue. If the issue is not resolved, contact Alipay Technical Support. |
| CURRENCY_NOT_SUPPORTED | F | The currency is not supported. | Contact Alipay Technical Support for detailed reasons. |
| MERCHANT_NOT_REGISTERED | F | The sub-merchant is not registered. | Please register the sub-merchant by using the register interface. Contact Alipay Technical Support if failed to call the registration interface. |