View Categories

New Claim

1 min read

To file a complaint related to a transaction, the partner can send a POST request to the following URL, including the subject of the complaint, the message, and the transaction ID.

{{base_url}}/api-services/v1/new-claim

Headers

Parameter NameValueMendatoryDescription
apikeyStringYesyour API key (provided by RichattPay)

Body

{
    "subject": "CLAIM_SUBJECT",
    "message": "CLAIM_MESSAGE",
    "transactionId": "XXXXXXXXXXXXXXXXXXXX"

}

Example of successful response

{ 
    "code": 2000, 
    "msg": "Successfully operation", 
    "error": false, 
    "data": { 
        "claim": { 
            "statut": "OPENED", 
            "subject": "Subject Here", 
            "message": "Hi customer...", 
            "transactionId": 102453, 
            "openedAt": "2022-09-15T15:03:27.339Z", 
            "createdAt": "2022-09-15T15:03:27.339Z", 
            "partenersId": 1, 
            "claimRef": "C98662712961324", 
            "comment": null, 
            "callbackUrl": null, 
            "userIdOpen": null, 
            "userIdClose": null, 
            "userIdComment": null, 
            "updatedAt": null, 
            "closeAt": null, 
            "id": 1, 
            "state": "ACTIVED" 
        } 
    } 
}

Examples of error response

Status(403)

{"error":" The API key is missing or expired"}

Status(404)

{"error":"The transaction reference is not found "}

Status(500)

{"error":"An error occurred. Please try again later "}