inquireDeclarationRequestsACQP → Alipay+
The inquireDeclarationRequests API is used by the Acquiring Service Provider (ACQP) to inquire about the status of declared payments.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Note:
1. Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:
- If the data type of a parameter is Integer and its value is 20, set it as "20".
- If the data type of a parameter is Boolean and its value is true, set it as "true".
2. For optional parameters that are not required in your case, you can take one of the following actions:
- Exclude the parameters from the request body.
- Set the parameter values as null (without the double quotation marks).
Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.
Request parameters
declarationRequestIds Array<String> REQUIRED
The unique declaration request IDs that are assigned by the merchant to identify declaration requests. Up to 10 declaration request IDs are supported at a time.
More information:
- Maximum length: 64 characters
- Maximum size: 10 elements
Response parameters
result Result REQUIRED
The result of the business processing, including the result status, result code, and the result message.
This parameter only indicates the result of the declaration inquiry request, but does not indicate the result of declarations.
declarationRequestsNotFound Array<String>
The list of declaration request IDs that are not found in the customs system.
This parameter is returned by Alipay+ if result.resultCode is S and one or multiple declaration request IDs can't refer to any existing declarations.
More information:
- Maximum length: 64 characters
- Maximum size: 10 elements
declarationRecords Array<DeclarationRecord>
The list of customs declaration records. Each record represents a customs declaration.
This parameter is returned by Alipay+ if result.resultCode is S.
More information:
- Maximum size: 10 elements
Request
Response
More information
How to handle the result
You might receive different results from Alipay+. Follow the instructions below to handle the result.
result.resultStatus result.resultCode Inquiry status Actions Inquiry succeeds. N/A Multiple possible values exist, such as Inquiry fails. Take actions according to the result code (specified on the result.resultCode parameter). For more information, see the Result codes section below. Multiple possible values exist, such as Unknown Use the same parameters to retry the inquireDeclarationRequests request. If you keep receiving the same result indicating the unknown status, contact connect_support@service.alipay.com. No result received Unknown Use the same parameters to retry the inquireDeclarationRequests request. If you keep receiving no result, contact connect_support@service.alipay.com.SSUCCESSFACCESS_DENIED, KEY_NOT_FOUND, etc.UUNKNOWN_EXCEPTION, REQUEST_TRAFFIC_EXCEED_LIMIT, etc.
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | N/A |
| ACCESS_DENIED | F | Access is denied. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| COUNT_OF_REQUEST_EXCEED_LIMIT | F | For each inquiry, only up to 10 declaration request IDs can be used. | Ensure that the number of declaration request IDs in the request does not exceed 10. |
| INVALID_CLIENT | F | The client is invalid. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| INVALID_SIGNATURE | F | The signature is invalid. | Check whether the public key, signed message, and signature algorithm are as expected. |
| KEY_NOT_FOUND | F | The key is not found. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| MEDIA_TYPE_NOT_ACCEPTABLE | F | The server does not implement the media type that is acceptable to the client. | Use a media type that is accepted by Alipay+. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTPS method. | Ensure the HTTP method is POST. |
| NO_INTERFACE_DEF | F | API is not defined. | Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. |
| PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. | Check whether the request parameters, including the header parameters and body parameters, are correct and valid. For more information about the parameters of each API, see the Structure section of the specific API reference topic. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Reduce the frequency of API calls. |
| UNKNOWN_EXCEPTION | U | An API call failed, which is caused by unknown reasons. | Try to recall the API. |