Skip to main content
GET
/
api
/
v4.0
/
integrations
/
transactions
cURL
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/transactions \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "transactions": [
    {
      "transactionId": "txn123456",
      "gameballTransactionId": "11034736",
      "type": "Cancel",
      "direction": "-",
      "customerId": "cust_12345abc",
      "points": 10,
      "amount": 10,
      "transactionTime": "2024-10-13T17:11:00.249",
      "status": "Active",
      "couponCode": null,
      "isCouponUsed": false,
      "couponType": null,
      "merchantName": "MERCH1234",
      "branchName": "BRANCH123",
      "reason": "trx reason",
      "achievementName": null,
      "expiryDate": "2025-10-13T17:11:00.249",
      "pointsBalanceBefore": 1164,
      "pointsBalanceAfter": 1154,
      "achievementType": null,
      "achievedRewardCampaignId": null,
      "achievedTierId": null
    }
  ],
  "count": 2,
  "hasMore": true
}

​
List Transactions

This API retrieves a paged list of transactions from Gameball, allowing for optional filtering. Each transaction record includes details such as type, direction, points, amount, transaction time, and balance changes, providing a comprehensive view of customer activity.
Channel Merging Available If your system uses different customer IDs across multiple channels (e.g., online and offline), Gameball’s channel merging feature helps unify customer profiles. By including the customer’s mobile number or email (based on your merging configuration) with each request, Gameball will combine activities into a single profile.
Security: Provide both apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Query Parameters

​
direction
string

Direction of the transaction: + (Accumulation - points or rewards added to the customer), - (Deduction - points or rewards removed from the customer).

​
status
string

Represents the current status of the transaction. Possible values are: Active (The transaction is fully completed, and any points or rewards have been successfully added or redeemed), Pending (Points or rewards from the transaction are pending during the return window period), Blocked (The transaction has been flagged and blocked due to suspected fraud or other security concerns), Expired (The points or rewards earned in this transaction have expired and are no longer available for redemption or use).

​
startAfter
integer

Specifies the page will start after which transaction id. Defaults to 0.

​
limit
integer
default:50

Specifies the number of transactions to be returned per page. Defaults to 50, with a maximum limit of 200 transactions per page.

​
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. This is used to filter the transactions of the specified customer.

Response

200 - application/json

Transactions retrieved successfully

​
transactions
object[]
​
count
number

The total number of transactions on the current page.

Example:

2

​
hasMore
boolean

Indicating whether there are additional transactions to be fetched beyond the current page.

Example:

true