Skip to main content
POST
/
api
/
v4.0
/
integrations
/
transactions
/
cashback
cURL
curl --request POST \
  --url https://api.gameball.co/api/v4.0/integrations/transactions/cashback \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "customerId": "cust_12345abc",
  "transactionId": "TXN987654321",
  "transactionTime": "2024-10-11T10:48:56.719Z",
  "amount": 150.75,
  "email": "john.doe@example.com",
  "mobile": "+1234567890",
  "merchant": {
    "uniqueId": "<string>",
    "name": "<string>",
    "branch": {
      "uniqueId": "<string>",
      "name": "<string>"
    }
  },
  "configurations": {
    "returnWindow": 7
  }
}
'
{
  "customerId": "cust_12345abc",
  "gameballTransactionId": 11034733,
  "rewardAmount": 150.75,
  "rewardEquivalentPoints": 0
}

Authorizations

​
apikey
string
header
required

Body

application/json
​
customerId
string
required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer.

Example:

"cust_12345abc"

​
transactionId
string
required

A unique identifier for a transaction in your system (e.g., order number or invoice number). This ID is critical for managing transaction lifecycle events such as reversals, cancellations, or refunds in Gameball.

Example:

"TXN987654321"

​
transactionTime
string<date-time>
required

The time of the transaction in your system (e.g., order datetime, invoice datetime).

Example:

"2024-10-11T10:48:56.719Z"

​
amount
number
required

Monetary value of the transaction for which the customer will be rewarded, based on the Cashback program configuration.

Example:

150.75

​
email
string

Customer's email address. This is required if your account uses email-based channel merging.

Example:

"john.doe@example.com"

​
mobile
string

Customer's mobile number. This is required if your account uses mobile-based channel merging.

Example:

"+1234567890"

​
merchant
object

This object contains details about the specific merchant involved in the transaction, which is particularly important for businesses managing multiple merchants or branches under the same Gameball account. This object can provide identifying information about both the main merchant and any associated branch where the transaction took place.

​
configurations
object

This object contains configurations related to the cashback settings.

Response

200 - application/json

Cashback issued successfully

​
customerId
string

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

Example:

"cust_12345abc"

​
gameballTransactionId
number

Unique identifier for the transaction in the Gameball system.

Example:

11034733

​
rewardAmount
number

The monetary value equivalent of the points rewarded to the customer for the transaction. Example: If the customer earns 50 points for their purchase and each point is worth $0.10, the rewardAmount will be $5.

Example:

150.75

​
rewardEquivalentPoints
number

The number of points rewarded to the customer for the transaction. Example: If the customer earns 50 points for their purchase, the rewardEquivalentPoints will be 50.

Example:

0