Alipay+Alipay+
APIs & SDKs

inquireDeclarationRequestsACQP → Alipay+

POST /aps/api/v1/customs/inquireDeclarationRequests

The inquireDeclarationRequests API is used by the Acquiring Service Provider (ACQP) to query the status of an payment order that is declared to the customs. 

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

declarationRequestIds Array<String>  REQUIRED

The unique declaration request IDs that are assigned by the merchant to identify declaration requests. Batch queries are supported, and up to 10 declaration request IDs are supported at a time. 

More information about this field:

  • Maximum size: 10 elements

Response parameters

result Result object REQUIRED

The result of the business processing, including the result status, result code, and the result message.

Note: This parameter only indicates the result of the declaration request inquiry, but does not indicate the result of declarations or declaration requests. 

Show child parameters

declarationRequestsNotFound Array<String>  

The list of declaration request IDs that are not found in the customs system.

Note: Returned by Alipay+ if result.resultCode is S and one or multiple declaration request IDs can't refer to any existing declarations. 

More information about this field:

  • Maximum size: 10 elements

declarationRecords Array<DeclarationRecord> object 

The list of customs declaration records. Each record represents a customs declaration.

Note: Returned by Alipay+ if result.resultCode is S

More information about this field:

  • Maximum size: 10 elements
Show child parameters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess

N/A

ACCESS_DENIEDFAccess is denied.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

COUNT_OF_REQUEST_EXCEED_LIMITFFor 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_CLIENTFThe client is invalid.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

INVALID_SIGNATUREFThe signature is invalid.

Check whether the public key, signed message, and signature algorithm are as expected. 

KEY_NOT_FOUNDFThe key is not found.

It is recommended that you contact connect_support@service.alipay.com to troubleshoot the issue. 

MEDIA_TYPE_NOT_ACCEPTABLEFThe server does not implement the media type that is acceptable to the client.

Use a media type that is accepted by Alipay+. 

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTPS method.

Ensure the HTTP method is POST. 

NO_INTERFACE_DEFFAPI is not defined.

Check whether the request URL is correct. Ensure that the endpoint of the called API is correct. 

PARAM_ILLEGALFIllegal 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_FAILFA 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_LIMITUThe request traffic exceeds the limit.

Reduce the frequency of API calls. 

UNKNOWN_EXCEPTIONUAn API call failed, which is caused by unknown reasons.

Try to recall the API.