Antom, leading provider of tailored payment solutionsAntom, leading provider of tailored payment solutions

supplyDefenseDocument

POST /v1/payments/supplyDefenseDocument

Use this 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 Antom to identify a dispute.

More information:

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

  • Maximum length: 1000000 characters

Response parameters

result Result  REQUIRED

The result of the API call.

Show child parameters

disputeId string  

The unique ID assigned by Antom to identify a dispute.

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

More information:

  • Maximum length: 64 characters

disputeResolutionTime string  

The time when you upload the dispute defense document.

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

More information:

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

Request

URL
Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess.

No further action is needed.

DEFENSE_EXCEED_LIMIT FThe defense is greater than the maximum times allowed. This error code applies only to compliance request.

Contact Antom Technical Support to know the specific limitation.

NOT_ALLOW_IN_CURRENT_STATUSFThe merchant repeated the upload after submitting the rebuttal materials without having received the verification result. This error code applies only to compliance request.

Contact Antom Technical Support to check the reason.

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 Antom Technical Support to check the dispute status.

TIME_EXCEEDS_LIMITFYour defense is overdue and you cannot accept or defend the dispute.

Contact Antom Technical Support.

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

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