POST /api/v4.0/integrations/transactions/cashback

This API awards loyalty points to customers in Gameball through a cashback program based on the amount.

post/api/v4.0/integrations/transactions/cashback

Request body

customerIdstring 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.

emailstring

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

mobilestring

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

transactionIdstring 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.

transactionTimestring date-time required

The time of the transaction in your system (e.g., order datetime, invoice datetime). Must be in UTC (ISO 8601 format).

amountnumber required

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

Example request

{
  "customerId": "cust_12345abc",
  "email": "john.doe@example.com",
  "mobile": "+1234567890",
  "transactionId": "TXN987654321",
  "transactionTime": "2024-10-11T10:48:56.719Z",
  "amount": 150.75,
  "configurations": {
    "returnWindow": 7
  }
}

Response

Cashback issued successfully

customerIdstring

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.

gameballTransactionIdnumber

Unique identifier for the transaction in the Gameball system.

rewardAmountnumber

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.

rewardEquivalentPointsnumber

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 response

{
  "customerId": "cust_12345abc",
  "gameballTransactionId": 11034733,
  "rewardAmount": 150.75
}

Changes

Changed in 4 of the 38 revisions of this API.2213

Dec 17, 2025262228c134293See the full diff
- ○
  the endpoint scheme security apiKey AND secretKey was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  the endpoint scheme security secretKey was removed from the API
  api-security-removed
Sep 30, 2025788718651767129See the full diff
- ▲
  added the new required request property transactionTime
  new-required-request-property
- ●
  removed the optional property newBalance from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property success from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional request property configurations
  new-optional-request-property
- ○
  added the new optional request property email
  new-optional-request-property
- ○
  added the new optional request property merchant
  new-optional-request-property
- ○
  added the new optional request property mobile
  new-optional-request-property
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  added the optional property customerId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property gameballTransactionId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property rewardAmount to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property rewardEquivalentPoints to the response with the 200 status
  response-optional-property-added
Sep 10, 202595e7f65e5afd1See the full diff
- ○
  endpoint added
  endpoint-added
Sep 2, 2025919eb7a392aa1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 38 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history