Changed on

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.

get/api/v4.0/integrations/transactions

Request

  • Base URL: https://api.gameball.co
  • URL: https://api.gameball.co/api/v4.0/integrations/transactions
  • Auth: API key in header apikey and API key in header secretkey

Query parameters

directionstring

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

statusstring

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

startAfterinteger

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

limitinteger

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

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

Response

Transactions retrieved successfully

countnumber

The total number of transactions on the current page.

hasMoreboolean

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

Example response

{
  "transactions": [
    {
      "transactionId": "txn123456",
      "gameballTransactionId": "11034736",
      "type": "Cancel",
      "direction": "-",
      "customerId": "cust_12345abc",
      "points": 10,
      "amount": 10,
      "transactionTime": "2024-10-13T17:11:00.249",
      "status": "Active",
      "merchantName": "MERCH1234",
      "branchName": "BRANCH123",
      "reason": "trx reason",
      "expiryDate": "2025-10-13T17:11:00.249",
      "pointsBalanceBefore": 1164,
      "pointsBalanceAfter": 1154
    }
  ],
  "count": 2,
  "hasMore": true
}

Changes

  • 262228c13429Revision changes
    • info

      the endpoint scheme security apiKey AND secretKey was added to the API

    • info

      the endpoint scheme security apiKey was removed from the API

    • info

      the endpoint scheme security secretKey was removed from the API

  • 788718651767Revision changes
    • breaking

      for the query request parameter limit, default value was changed from 20 to 50

    • warning

      deleted the query request parameter offset

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter direction

    • info

      added the new optional query request parameter startAfter

    • info

      added the new optional query request parameter status

    • info

      the query request parameter customerId became optional

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status