Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

supplyDefenseDocument

POST /v1/payments/supplyDefenseDocument

Use the supplyDefenseDocument API to defend a dispute by uploading the necessary evidence within the specified time limit.

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

disputeId string  REQUIRED

The unique ID assigned by Alipay to identify a dispute.

More information about this field

  • Maximum length: 64 characters

disputeEvidence string  REQUIRED

The dispute defense document that you prepare for defending the dispute, which is encoded in the Base64 format.

More information about this field

  • Maximum length: 1000000 characters

Response parameters

result Result object REQUIRED

The result of the API call.

Show child parameters

disputeId string  

The unique ID assigned by Alipay to identify a dispute。

This prameter is returned when the value of resultCode is SUCCESS.

More information about this field

  • Maximum length: 64 characters

disputeResolutionTime string  

The time when you upload the dispute defense document.

This prameter is returned when the value of resultCode is SUCCESS.

More information about this field

  • Maximum length: 64 characters
API Explorer
Sample CodesRun in Sandbox

Request

URL
Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess.
PARAM_ILLEGALFIllegal parameters. For example, non-numeric input, invalid date.

Check and verify whether the required request fields (including the header fields and body fields) of the current API are correctly passed and valid. 

REPEAT_REQUESTFRepeated request.

Contact Alipay Technical Support to check the dispute status.

TIME_EXCEEDS_LIMITFYour defense is overdue and you cannot accept or defend the dispute.
UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support.