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

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[]

Show child attributes

transactions.transactionId

string

A unique identifier for a transaction in your system (e.g., order number or invoice number). This ID can be used to reverse, cancel, or refund any reward or redemption transactions in Gameball.

Example:

"txn123456"

transactions.gameballTransactionId

string

Unique identifier for the transaction in the Gameball system.

Example:

"11034736"

transactions.type

string

Type of the transaction. Possible values: AchievementReward, PaymentReward, Refund, Redemption, Expiry, Cancel, Migration, ManualAccumulation, DiscountCode, ManualDeduction, ManualReward.

Example:

"Cancel"

transactions.direction

string

Direction of the transaction: + (Accumulation), - (Deduction).

Example:

"-"

transactions.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"

transactions.points

number

Number of points involved in the transaction.

Example:

10

transactions.amount

number

Monetary value associated with the transaction.

Example:

10

transactions.transactionTime

string<date-time>

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

Example:

"2024-10-13T17:11:00.249"

transactions.status

string

Status of the transaction: Active (The transaction is completed, and any rewards or points have been applied successfully), Pending (The points or rewards from the transaction are temporarily on hold during the return window or any other pending period), Blocked (The transaction was flagged for potential fraud or another issue and is currently blocked from processing), Expired (Points or rewards from the transaction have expired and are no longer available for use).

Example:

"Active"

transactions.couponCode

string

The code for the coupon that the customer has redeemed during the transaction. This value is present if the transaction represents a redemption process initiated by the customer.

Example:

null

transactions.isCouponUsed

boolean

Indicates whether the coupon redeemed in this transaction has been used by the customer. This flag signifies if the coupon applied in the redemption process has already been utilized or can be redeemed again.

Example:

false

transactions.couponType

string

The type of the coupon code that the customer has redeemed during the redemption transaction. Possible values: free_shipping, percentage_discount, fixed_discount, free_product, fixed_rate_discount, custom.

Example:

null

transactions.merchantName

string

Name of the merchant involved in the transaction, if any.

Example:

"MERCH1234"

transactions.branchName

string

Name of the branch involved in the transaction, if any.

Example:

"BRANCH123"

transactions.reason

string

Reason for the transaction, if applicable.

Example:

"trx reason"

transactions.achievementName

string

The name of the reward campaign associated with the transaction, indicating the specific achievement involved in the transaction, if applicable.

Example:

null

transactions.expiryDate

string<date-time>

Date when the points or rewards from the transaction will expire, if applicable.

Example:

"2025-10-13T17:11:00.249"

transactions.pointsBalanceBefore

number

The customer's points balance before the transaction occurred.

Example:

1164

transactions.pointsBalanceAfter

number

The customer's points balance after the transaction is completed.

Example:

1154

transactions.achievementType

string

Type of achievement earned during the transaction, if applicable.

Example:

null

transactions.achievedRewardCampaignId

string

The ID of the reward campaign associated with the transaction, indicating that the customer earned points in this transaction as a reward for achieving this campaign.

Example:

null

transactions.achievedTierId

number

The ID of the tier associated with the transaction, indicating that the customer earned this transaction as a reward for reaching this tier.

Example:

null

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

API documentation

Webhooks

List Transactions