Alipay+Alipay+

responseEscalation

The responseEscalation API is used by the Acquiring Partner (ACQP) to send the information that is related to an escalation to Alipay+, as a reply to Alipay+'s initiateEscalation 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 an escalation. 

Note: If two requests specify the same value for disputeRequestId but different values for paymentRequestId, Alipay+ returns REPEAT_REQ_INCONSISTENT for the second request. 

More information about this field:

  • This field is an API idempotency field.
  • Maximum length: 64 characters

refundType String  REQUIRED

The refund result that reflects whether the ACQP agrees to refund or not. Valid values are:

  • ACCEPT_REFUND: indicates that the refund is accepted.
  • ACCEPT_PARTIAL_REFUND: indicates that the refund is partially accepted.
  • REFUSE_REFUND: indicates that the refund is refused. 

refundAmount Amount object 

The amount that the ACQP agrees to refund. 

Notes:

  • Required if refundType is ACCEPT_PARTIAL_REFUND.
  • When refundType is ACCEPT_REFUND, the value of refundAmount.value is by default the same as the value of escalationAmount.value that is specified by Alipay+ in the initiateEscalation API.
  • The value of refundAmount.value cannot exceed the value of escalationAmount.value that is specified by Alipay+ in the initiateEscalation API.
  • The value of refundAmount.currency needs to be the same as the value of paymentAmount.currency in the pay API. 
Show child parameters

plannedRefundTime Datetime  

The date and time when the ACQP plans to process the refund.

Note: It is recommended to specify this parameter if refundType is ACCEPT_REFUND or ACCEPT_PARTIAL_REFUND

More information about this field:

  • The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

transactionReceipt TransactionReceipt object 

Transaction receipt of the payment.

Note: For when to specify this parameter, see How to specify request parameters

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.

Note: For when to specify this parameter, see How to specify request parameters

Show child parameters

merchantInformation Merchant object 

The merchant information.

Note: For when to specify this parameter, see How to specify request parameters

Show child parameters

endUserInformation Buyer object 

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

Note: For when to specify this parameter, see How to specify request parameters

Show child parameters

otherDocumentation Array<Attachment> object 

The list of any other documents.

Note: For when to specify this parameter, see How to specify request parameters

Show child parameters

remarks String  

Supplementary information.

Note: It is recommended to specify this parameter if the ACQP wants to pass any information to the Mobile Payment Partner. 

More information about this field:

  • Maximum length: 2048 characters

Response parameters

result Result object REQUIRED

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

Show child parameters
API Explorer
Run in SandboxSample Codes

Request

Method
POST
Endpoint
/aps/api/v1/disputes/responseEscalation
Header
Accept: application/json
URL
https://<domain_name><endpoint>
Domain name
https://open-sea.alipayplus.com
Request Body (ACQP to Alipay+)

Response

Response Body (Alipay+ to ACQP)

How to specify request parameters

transactionReceipt&proofDelivery&merchantInformation&endUserInformation&otherDocumentation: If the value of refundType is ACCEPT_PARTIAL_REFUND or REFUSE_REFUND, at least one of these 5 parameters needs to be specified. 

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. 

CURRENCY_NOT_SUPPORTFThe currency is not supported.

Ensure that the value of refundAmount.currency is the same as the value of paymentAmount.currency in the pay API. 

EXCEEDS_ESCALATION_RESPONSE_TIME_LIMITFThe time limit of the escalation response for the transaction is exceeded.

Ensure that the escalation 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 server does not implement the media type that is acceptable to the client.

Use a media type that is accepted by Alipay+. 

METHOD_NOT_SUPPORTEDFAPI is not defined.

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

ORDER_NOT_EXISTFThe order doesn't exist.

Ensure that 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. 

REFUND_AMOUNT_EXCEED_LIMITFThe refund amount exceeds the escalation amount.

Ensure that the value of refundAmount.value is lower than the value of escalationAmount.value in the initiateEscalation API. 

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.