Check Reward - RETM

This webhook is triggered when the user inputs a Promotional Coupon from the POS App.

You are able to customize a button with the success callback, the URL within the button will act as a GET request with all the parameters.

Request:

Property	Type	Description
reward_code	String	Promotion reward Code
business_refrence	String	Business Name

Example Response:

1- Valid response: [2xx OK]

{
    "data":{
        "type": "1:for order,2:for product",
        "is_percentage": "boolean",
        "customer_number": "",
        "discount_amount": "",
        "max_discount_amount": "0:unlimit",
        "allowed_products": {
                "product_id": [],
                "quantity": number
        },
        "button": {
            "label": { 
                "ar": "string",
                "en": "string"
            },
            "url": "",
            "close_modal": "boolean"
        }
    },
     "errors": []
 }

2- Invalid responde [400 BAD REQUEST]

{
    "data":[], // optional
    "message": "Reward 1234 has been used", // either message or errors
    "errors": ["merchant doesn't exist"]
}

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Valid Response

application/json

Body

Example

{
    "data": {
        "type": "1:for order,2:for product",
        "is_percentage": "boolean",
        "customer_number": "",
        "discount_amount": "",
        "max_discount_amount": "0:unlimit",
        "allowed_products": {
            "product_id": [
                "01hq5nrmegrsked61pj7c261k7",
                "01HX4FQD0AW610ERN8R2524VGW"
            ],
            "quantity": 1
        },
        "button": {
            "label": {
                "ar": "string",
                "en": "string"
            },
            "url": "",
            "close_modal": "boolean"
        }
    },
    "errors": []
}

🟠400Invalid response