Alipay+Alipay+

responseRetrieval

POST /aps/api/v1/disputes/responseRetrieval

The responseRetrieval API is used by the Acquiring Partner (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: 

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

disputeRequestId String  REQUIRED

The unique ID that is assigned by Alipay+ to identify a retrieval request. 

More information about this field:

  • This field is an API idempotency field.
  • 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.

Notes:

  • Required if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as TRANSACTION_RECEIPT.
  • If the value of otherDocumentation contains TRANSACTION_RECEIPT, this parameter can be empty. 
Show child parameters

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.

Notes:

  • Required if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as PROOF_OF_DELIVERY.
  • If the value of otherDocumentation contains PROOF_OF_DELIVERY, this parameter can be empty.
Show child parameters

merchantInformation Merchant object 

The merchant information.

Notes:

  • Required if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as MERCHANT_INFORMATION.
  • If the value of otherDocumentation contains MERCHANT_INFORMATION, this parameter can be empty. 
Show child parameters

endUserInformation Buyer object 

The information of the end-user, also called the buyer.

Notes:

  • Required if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as END_USER_INFORMATION.
  • If the value of otherDocumentation contains END_USER_INFORMATION, this parameter can be empty. 
Show child parameters

otherDocumentation Array<Attachment> object 

The list of any other documents that are required.

Note: Required if responseCode is 0001 and requestInformationType in the initiateRetrieval API is specified by Alipay+ as OTHER_INFORMATION

Show child parameters

Response parameters

result Result object 

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

Show child parameters
API Explorer
Sample CodesRun in Sandbox

Request

URL
https://open-sea.alipayplus.com/aps/api/v1/disputes/responseRetrieval
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.

EXCEEDS_RETRIEVAL_RESPONSE_TIME_LIMITFThe request exceeds retrieval response time limits.

Ensure that the retrieval request is responded to within 20 days after being received. 

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_DEFFThe order does not exist.

Ensure the value of disputeRequestId is correct. 

ORDER_NOT_EXISTFThe order does not exist.

Ensure the value of disputeRequestId 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.