Dispute Contest

Usage Flow

1. First call the Upload File API to obtain the storage path of the evidence file.
2. Use the returned storageUri value as the url field value of the evidence.
3. Call this API to submit the dispute contest along with the related evidences.

Request URL

https://{{gateway_domain}}/pg/v2/dispute/contest

Request Parameters

HTTP Method

POST

HTTP Header

Field	Data Type	Length Limit	Required	Description
Content-Type	String	N/A	YES	This field value only supports application/json.
Accept	String	N/A	YES	This field value only supports application/json.
Authorization	String		YES	Authorization: {type} {credentials}, refer to the Signature specification

HTTP Body

Field	Data Type	Length Limit	Required	Description
disputeNo	String	32	YES	Dispute number on platform
evidenceList	Array[OpenDisputeEvidence]	N/A	YES	Dispute evidence list

Description of evidenceList

Field	Data Type	Length Limit	Required	Description
type	String	N/A	YES	Evidence type, supports: OTHER (Other), REFUND (Refund), RECEIPT (Receipt), DEFAULT (Default)
name	String	N/A	YES	Evidence name
url	String	N/A	YES	Evidence file storage path, which needs to be obtained through the Upload File API (storageUri), see the docs

Response Data

HTTP Header

Field	Data Type	Required	Description
Content-Type	String	YES	This field value only supports application/json.
Authorization	String	YES	Authorization: {type} {credentials}, refer to the Signature specification

HTTP Body

Field	Data Type	Required	Description
code	String	YES	Refer to the response codes
errorMessage	String	NO	Error message
data	JSON Object	NO

Description of data field

Field	Data Type	Required	Description
result	Boolean	NO	Update result

Examples

Request

curl https://{{gateway_domain}}/pg/v2/dispute/contest \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H 'Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=9e494e8a91bcdd08f18ad5b2cfdbfd5654f5c00c89f8216eebd7c1637b6ce01b,timestamp=1714128828114,nonce=C7CA27DC6D55DA935DFC8450C721CC99' \
  -d '{
    "disputeNo": "1234567890",
    "evidenceList": [
      {
        "type": "RECEIPT",
        "name": "Transaction receipt",
        "url": "s3://uploaded/m/80/open/dispute-evidence/2ace1b345cbb4a09852d7d92e540591a.png"
      },
      {
        "type": "REFUND",
        "name": "Refund proof",
        "url": "s3://uploaded/m/80/open/dispute-evidence/ed283d5a58034c4a947b18d77621d9d8.pdf"
      }
    ]
}'

Response

HTTP/1.1 200 OK
Content-Type: application/json
Server: nginx/1.18.0
Date: Mon, 06 Mar 2024 12:00:00 GMT
Authorization: V2_SHA256 appId=1111b620f93b48c5904210ff47bb1111,sign=ac6ae72f8c46f5c2092c3dab9bb0e08b6cdb6d5e7ff8ad190499a8955d57f297,timestamp=1714128245401,nonce=28FA11BF8FD1309767551B4FD8A57BD5

{
    "code": "OK",
    "errorMessage": null,
    "data": {
      "result": true
    }
}