Redeem rewards

Staging

https://testserver.loyi.io/public/api

GET

/reward/redeem

Redeems multiple rewards with the specified IDs. This operation is used to make a user redeem rewards.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://testserver.loyi.io/public/api/reward/redeem?userId&rewardIds' \
--header 'Origin: <WHITELISTED_URL>' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

Body

Example

{
    "rewards": [
        {
            "id": "123e4567-e89b-12d3-a456-426655440000",
            "title": "Event Entry Pass",
            "description": "An entry pass for the event",
            "instruction": "Show this pass at the event entrance",
            "type": "EntryPass",
            "createdAt": "2022-01-01T00:00:00.000Z",
            "updatedAt": "2022-01-01T00:00:00.000Z"
        }
    ],
    "errors": [
        {
            "resourceId": "123e4567-e89b-12d3-a456-426655440000",
            "message": "You are not eligible to redeem this reward."
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-08-08 11:37:21

Award reward

Get owners