CreateDispute

Step 1: Create dispute

User can create dispute for a contract by providing the requester's id, contract id and reason for dispute.

Implementation Examples

POST apps/api/disputes

Headers:

• Authorization: Bearer {access_token} — Replace {access_token} with the token obtained from Step 1.
• Content-Type: application/json

{
    "requesterPlatformRefId": "USR_01KZ15DDR0KN",
    "externalContractId": "CNT-000000GFZ000",
    "reason": "OtherDisputeReason",
    "otherMessage": "some text to explain the dispute",
    "suggestions": "explain the suggestions"
}

Field Descriptions

Field Name	Type	Description	Required / Notes / Example
requesterPlatformRefId	string	Requester's platform reference ID	Required
externalContractId	string	External contract ID	Required
reason	string	Reason for dispute	Required
otherMessage	string	Additional message for dispute	Optional
suggestions	string	Suggestions for dispute resolution	Optional

Example Request (cURL)

curl --location 'https://localhost:50676/apps/api/dispute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YourTokenGoesHere' \
--data '{
    "externalContractId": "CNT-01KX12PR976YD7FFKRWNQ58DQT",
    "reason": "ProductNotGood",    
    "suggestions": "Suggestions"
}'

Example Response

{
    "data": {
        "disputeId": 1
    },
    "message": "Dispute created and contract status updated successfully.",
    "status": 200,
    "errorCode": null,
    "validationErrors": []
}

Reasons options

public enum DisputeReasons
{
    ProductNotGood = 1,
    ServiceNotMatchingRequirements = 2,
    DeliveryIssue = 3,
    PaymentIssue = 4,
    ContractViolation = 5,
    DamagedProduct = 6,
    ServiceIncomplete = 7,
    OtherDisputeReason = 99
}