Skip to main content
GET
/
api
/
v4.0
/
integrations
/
configurations
/
cashback
cURL
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/configurations/cashback \
  --header 'apikey: <api-key>'
{
  "defaultCashbackRule": {
    "amountRewardThreshold": 1,
    "rewardWalletFactor": 1,
    "rewardRankFactor": 1,
    "rewardFactor": 10
  },
  "tierCashbackRules": [
    {
      "tierName": "Gold",
      "amountRewardThreshold": 1,
      "rewardWalletFactor": 20,
      "rewardRankFactor": 1,
      "rewardFactor": 0
    }
  ]
}

​
Cashback Configurations

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.
Security: Requires apikey header.

Authorizations

​
apikey
string
header
required

Query Parameters

​
customerId
string

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

200 - application/json

Cashback configurations retrieved successfully

​
defaultCashbackRule
object

The default cashback rule applied to all customers if no tier-specific rules are available.

​
tierCashbackRules
object[]

A list of tier-specific cashback rules, which override the default cashback rule for customers in a specific tier.