Xtrempay Api Documentation

Configure prize tiers for a challenge

Cloud Mock

https://mock.apidog.com/m1/918700-0-default

POST

/{id}/prize-tiers

Maintainer:Not configured

Configures custom prize tiers for a trivia challenge. This endpoint replaces any existing prize tiers for the challenge.

Important Notes:

This endpoint is used when the challenge's sharingFormula is set to CUSTOM

All existing prize tiers for this challenge will be deleted and replaced with the new configuration

Tiers should not overlap (each position should belong to only one tier)

tierOrder determines the priority (1 = highest tier)

startPosition and endPosition define the range of positions in this tier (inclusive)

Each position in a tier receives the same prizeAmount

Example Configuration:

Gold tier: Positions 1-3, ₦3,000 each

Silver tier: Positions 4-10, ₦1,500 each

Bronze tier: Positions 11-20, ₦500 each

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Example

[
    {
        "tierName": "Gold",
        "tierOrder": 1,
        "startPosition": 1,
        "endPosition": 3,
        "prizeAmount": 3000
    },
    {
        "tierName": "Silver",
        "tierOrder": 2,
        "startPosition": 4,
        "endPosition": 10,
        "prizeAmount": 1500
    },
    {
        "tierName": "Bronze",
        "tierOrder": 3,
        "startPosition": 11,
        "endPosition": 20,
        "prizeAmount": 500
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mock.apidog.com/m1/918700-0-default/1/prize-tiers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "tierName": "Gold",
        "tierOrder": 1,
        "startPosition": 1,
        "endPosition": 3,
        "prizeAmount": 3000
    },
    {
        "tierName": "Silver",
        "tierOrder": 2,
        "startPosition": 4,
        "endPosition": 10,
        "prizeAmount": 1500
    },
    {
        "tierName": "Bronze",
        "tierOrder": 3,
        "startPosition": 11,
        "endPosition": 20,
        "prizeAmount": 500
    }
]'

Responses

🟢200OK

application/json

Prize tiers configured successfully

Body

Example

{
    "timestamp": "2024-01-15T10:30:00Z",
    "status": 200,
    "success": true,
    "message": "Prize tiers configured successfully",
    "data": [
        {
            "id": 1,
            "challengeId": 1,
            "tierName": "Gold",
            "tierOrder": 1,
            "startPosition": 1,
            "endPosition": 3,
            "prizeAmount": 3000,
            "createdAt": "2024-01-15T10:30:00Z",
            "updatedAt": "2024-01-15T10:30:00Z"
        },
        {
            "id": 2,
            "challengeId": 1,
            "tierName": "Silver",
            "tierOrder": 2,
            "startPosition": 4,
            "endPosition": 10,
            "prizeAmount": 1500,
            "createdAt": "2024-01-15T10:30:00Z",
            "updatedAt": "2024-01-15T10:30:00Z"
        },
        {
            "id": 3,
            "challengeId": 1,
            "tierName": "Bronze",
            "tierOrder": 3,
            "startPosition": 11,
            "endPosition": 20,
            "prizeAmount": 500,
            "createdAt": "2024-01-15T10:30:00Z",
            "updatedAt": "2024-01-15T10:30:00Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2026-01-16 11:18:25

Batch delete virtual accounts

Get prize tiers for a challenge