Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Reward Suppliers

Create a reward supplier

Creates a new reward supplier configuration. Returns the persisted supplier with its server-assigned id.

post/v6/reward-suppliers

Request body

OR
OR
OR
OR

Example request

{
  "cash_back_max": "handlebars@buildtime:{{cashBackMax}}",
  "cash_back_min": "handlebars@buildtime:{{cashBackMin}}",
  "cash_back_percentage": "handlebars@buildtime:{{cashBackPercentage}}",
  "description": "handlebars@buildtime:{{description}}",
  "display_name": "handlebars@buildtime:{{displayName}}",
  "display_type": "handlebars@buildtime:{{displayType}}",
  "enabled": "handlebars@buildtime:{{enabled}}",
  "face_value": "handlebars@buildtime:{{faceValue}}",
  "face_value_algorithm_type": "handlebars@buildtime:{{faceValueAlgorithmType}}",
  "face_value_type": "handlebars@buildtime:{{faceValueType}}",
  "limit_per_day": "handlebars@buildtime:{{limitPerDay}}",
  "limit_per_hour": "handlebars@buildtime:{{limitPerHour}}",
  "name": "handlebars@buildtime:{{name}}",
  "reward_expires_at": "2025-10-24T02:00:00-07:00"
}

Response

Successful response

OR
OR
OR
OR

Example response

{
  "cash_back_max": "handlebars@buildtime:{{cashBackMax}}",
  "cash_back_min": "handlebars@buildtime:{{cashBackMin}}",
  "cash_back_percentage": "handlebars@buildtime:{{cashBackPercentage}}",
  "created_date": "2025-10-24T02:00:00-07:00",
  "display_name": "handlebars@buildtime:{{displayName}}",
  "display_type": "handlebars@buildtime:{{displayType}}",
  "enabled": "handlebars@buildtime:{{enabled}}",
  "face_value": "handlebars@buildtime:{{faceValue}}",
  "face_value_algorithm_type": "handlebars@buildtime:{{faceValueAlgorithmType}}",
  "face_value_type": "handlebars@buildtime:{{faceValueType}}",
  "limit_per_day": "handlebars@buildtime:{{limitPerDay}}",
  "limit_per_hour": "handlebars@buildtime:{{limitPerHour}}",
  "name": "handlebars@buildtime:{{name}}",
  "reward_expires_at": "2025-10-24T02:00:00-07:00",
  "updated_date": "2025-10-24T02:00:00-07:00"
}