Sign in

This API call retrieves your cashback configurations, providing essential details about how cashback rewards are structured and managed in Gameball. If the customerId is provided, the API will return any special cashback rules associated with the customer's tier, including potential bonuses or customized reward factors specific to that customer.

get/api/v4.0/integrations/configurations/cashback

Query parameters

customerIdstring

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be database ID, random string, email or anything that uniquely identifies the customer. If provided, the response will return the cashback rules specific to this customer's tier, reflecting any special configurations or bonuses this customer is eligible for based on their tier cashback rules.

Response

Cashback configurations retrieved successfully

Example response

{
  "defaultCashbackRule": {
    "amountRewardThreshold": 1,
    "rewardWalletFactor": 1,
    "rewardRankFactor": 1,
    "rewardFactor": 10
  },
  "tierCashbackRules": [
    {
      "tierName": "Gold",
      "amountRewardThreshold": 1,
      "rewardWalletFactor": 20,
      "rewardRankFactor": 1
    }
  ]
}

Changes

Changed in 2 of the 38 revisions of this API.11