Antom, leading provider of tailored payment solutions

notifyDispute

The notifyDispute API is used by Alipay to send the dispute information to the merchant. 

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

paymentRequestId String  REQUIRED

The unique ID that is assigned by a merchant to identify a payment request. 

More information:

  • Maximum length: 64 characters

disputeId String  REQUIRED

The unique ID that is assigned by Alipay to identify a dispute.  

More information:

  • Maximum length: 64 characters

paymentId String  REQUIRED

The unique ID that is assigned by Alipay to identify a payment.  

More information:

  • Maximum length: 64 characters

disputeTime Datetime  

The date and time when the dispute is created.  

More information:

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

disputeAmount Amount  

The amount of the transaction which has a dispute. 
This parameter is returned when a dispute occurs.  

disputeNotificationType String  REQUIRED

The type of dispute notification. Valid values are:
  • DISPUTE_CREATED: Indicates that a dispute occurs.
  • DISPUTE_JUDGED: Indicates that the dispute is judged.  
  • DISPUTE_CANCELLED: indicates that the dispute is cancelled by the user.  
  • DEFENSE_SUPPLIED: indicates that your defense documents for the dispute are submitted.  

More information:

  • Maximum length: 30 characters

disputeReasonMsg String  

The dispute reason.   

More information:

  • Maximum length: 256 characters

disputeJudgedTime Datetime  

The date and time when the dispute is judged.  

More information:

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

disputeJudgedAmount Amount  

The deduction amount of the dispute. 
This parameter is returned when a dispute is judged.  

disputeJudgedResult String  

The result of the dispute judgement. Valid values are: 
  • ACCEPT_BY_CUSTOMER: Indicates that the dispute is the customer's responsibility. The merchant can process the transaction, such as refunding the customer, after the captured funds are unfrozen.  
  • ACCEPT_BY_MERCHANT: Indicates that the dispute is the merchant's responsibility. Deduct from the merchant settlement account, and the captured funds will be unfrozen.  

More information:

  • Maximum length: 30 characters

defenseDueTime Datetime  

The due time after which you cannot defend the dispute. 
This parameter is returned when the value of disputeNotificationType is DISPUTE_CREATED. 

Response parameters

result Result  REQUIRED

A fixed value, which is sent to Alipay to acknowledge that the notification is received.  
API Explorer

Request

Case
json
{
  "disputeAmount": {
    "currency": "EUR",
    "value": "1000"
  },
  "disputeId": "202209212501310115730104****",
  "disputeNotificationType": "DISPUTE_CREATED",
  "defenseDueTime": "2023-09-20T23:41:32-07:00",
  "disputeTime": "2022-09-20T23:41:32-07:00",
  "paymentId": "202209231540108001001888XXXXXX****",
  "paymentRequestId": "requestId_12345****"
}

Response

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success"
  }
}

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess