responseEscalationAlipay+ → MPP

The responseEscalation API is used by Alipay+ to send the information that is related to an escalation to the Mobile Payment Provider (MPP), as a reply to the MPP'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:

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 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:

This field is an API idempotency field.For requests that are initiated with the same disputeRequestId, the MPP must regard the requests as repeated and process the requests only once. The MPP is recommended to check the consistency of the refundType and refundAmount parameters. If either of their values is different from that in the previous request, Alipay+ returns the REPEAT_REQ_INCONSISTENT result code.
Maximum length: 64 characters

refundType String REQUIRED

The refund result that reflects whether the Acquiring Service Provider (ACQP) accepts the 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

The amount that the ACQP agrees to refund.

Notes:

Specified by Alipay+ 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 the MPP 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.

Show child parameters

plannedRefundTime Datetime

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

Note: Specified by Alipay+ if refundType is ACCEPT_REFUND or ACCEPT_PARTIAL_REFUND and the ACQP specifies this paramater in responseEscalation API.

More information:

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

transactionReceipt TransactionReceipt

The transaction receipt of the payment.

Note: Specified by Alipay+ if the ACQP has any transaction receipts of the payment.

Show child parameters

proofOfDelivery ProofOfDelivery REQUIRED

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: Specified by Alipay+ if the ACQP has any proof of delivery of the payment.

Show child parameters

merchantInformation Merchant

The merchant information.

Note: Specified by Alipay+ if the ACQP has any merchant information.

Show child parameters

endUserInformation Buyer

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

Note: Specified by Alipay+ if the ACQP has any end-user information.

Show child parameters

otherDocumentation Array<Attachment>

The list of any other documents.

Note: Specified by Alipay+ if the ACQP has any other documents.

Show child parameters

remarks String

Supplementary information.

Note: Specified by Alipay+ if there's any additional information that needs to be remarked.

More information:

Maximum length: 2048 characters

Response parameters

result Result REQUIRED

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

Show child parameters

API Explorer

Request

Request Body

Response

Response Body

More information

How to return the result

For different business processing results at your side, return the result (specified on the result parameter) by following the instructions below.

If the request is received successfully, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.
If the request fails to be received, set the value of result.resultStatus to F and specify the value of result.resultCode according to the failure reason.

For more information about how to define your result codes, see the Result codes section below.

Result/Error codes

Code	Value	Message
SUCCESS	S	Success
ACCESS_DENIED	F	Access is denied.
CURRENCY_NOT_SUPPORT	F	The currency is not supported.
EXCEEDS_ESCALATION_RESPONSE_TIME_LIMIT	F	The time limit of the escalation response for the transaction is exceeded.
INVALID_CLIENT	F	The client is invalid.
INVALID_SIGNATURE	F	The signature is invalid.
KEY_NOT_FOUND	F	The server does not implement the media type that is acceptable to the client.
METHOD_NOT_SUPPORTED	F	API is not defined.
ORDER_NOT_EXIST	F	The order doesn't exist.
PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
PROCESS_FAIL	F	A general business failure occurred. Do not retry.
REFUND_AMOUNT_EXCEED_LIMIT	F	The refund amount exceeds the escalation amount.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.
UNKNOWN_EXCEPTION	U	An API call failed, which is caused by unknown reasons.