responseRetrievalACQP → Alipay+
The responseRetrieval API is used by the Acquiring Service Provider (ACQP) to send the information that is required in a retrieval request to Alipay+, as a reply to the Alipay+'s initiateRetrieval request. The ACQP must send the response by using the responseRetrieval API within 20 days after Alipay+ sends the retrieval request.
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
disputeRequestId String REQUIRED
The unique ID that is assigned by Alipay+ to identify a retrieval request.
More information:
- This field is an API idempotency field.For requests that are initiated with the same disputeRequestId, Alipay+ returns the same result.
- Maximum length: 64 characters
responseCode String REQUIRED
The code that reflects whether the Acquiring Partner (ACQP) has enough information and/or documents required by the MPP in the retrieval request. Valid values are:
0001: The ACQP has all the information and/or documents required by the MPP in the retrieval request.0002: The ACQP has part of the information and/or documents required by the MPP in the retrieval request.0003: The ACQP has none of the information and/or documents required by the MPP in the retrieval request.
transactionReceipt TransactionReceipt object
All transaction receipts of the payment.
Specify the parameter if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as TRANSACTION_RECEIPT. However, if the value of otherDocumentation contains TRANSACTION_RECEIPT, this parameter can be empty.
proofOfDelivery ProofOfDelivery object
The document that is used to prove that the purchased product or service has been delivered as agreed, which contains information such as the delivery tracking number and the shipping information.
Specify this parameter if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as PROOF_OF_DELIVERY. However, if the value of otherDocumentation contains PROOF_OF_DELIVERY, this parameter can be empty.
merchantInformation Merchant object
The merchant information.
Specify this parameter if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as MERCHANT_INFORMATION . However, the value of otherDocumentation contains MERCHANT_INFORMATION, this parameter can be empty.
endUserInformation Buyer object
The information of the end-user, also called the buyer.
Specify this parameter if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as END_USER_INFORMATION. However, if the value of otherDocumentation contains END_USER_INFORMATION, this parameter can be empty.
otherDocumentation Array<Attachment> object
The list of any other documents that are required.
Specify this parameter if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as OTHER_INFORMATION.
Response parameters
result Result object
The result of the business processing, including the result status, result code, and the result message.
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 | Dispute status | Actions |
|
| The Retrieval Request is replied to successfully. | N/A |
| Multiple possible values exist, such as
| The Retrieval Request fails to be replied to. | Take actions according to the result code (specified in 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 responseRetrieval 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 responseRetrieval request. If you keep receiving no result, contact connect_support@service.alipay.com. | |
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. |
| EXCEEDS_RETRIEVAL_RESPONSE_TIME_LIMIT | F | The request exceeds retrieval response time limits. | Ensure that the retrieval request is responded to within 20 days after being received. |
| 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 | The order does not exist. | Ensure the value of disputeRequestId is correct. |
| ORDER_NOT_EXIST | F | The order does not exist. | Ensure the value of disputeRequestId 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. |