---
title: "GET /api/v4.0/integrations/transactions"
method: GET
path: "/api/v4.0/integrations/transactions"
---

# GET /api/v4.0/integrations/transactions

`GET /api/v4.0/integrations/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.

## Query parameters

- `direction` string
- `status` string
- `startAfter` integer
- `limit` integer
- `customerId` string

## Response `200`

Transactions retrieved successfully

- object
  - `transactions` object[]
    - `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.
    - `gameballTransactionId` string — Unique identifier for the transaction in the Gameball system.
    - `type` string — Type of the transaction. Possible values: AchievementReward, PaymentReward, Refund, Redemption, Expiry, Cancel, Migration, ManualAccumulation, DiscountCode, ManualDeduction, ManualReward.
    - `direction` string — Direction of the transaction: + (Accumulation), - (Deduction).
    - `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.
    - `points` number — Number of points involved in the transaction.
    - `amount` number — Monetary value associated with the transaction.
    - `transactionTime` string, date-time — The time of the transaction in your system (e.g., order datetime, invoice datetime), in UTC.
    - `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).
    - `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.
    - `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.
    - `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.
    - `merchantName` string — Name of the merchant involved in the transaction, if any.
    - `branchName` string — Name of the branch involved in the transaction, if any.
    - `reason` string — Reason for the transaction, if applicable.
    - `achievementName` string — The name of the reward campaign associated with the transaction, indicating the specific achievement involved in the transaction, if applicable.
    - `expiryDate` string, date-time — Date when the points or rewards from the transaction will expire, if applicable.
    - `pointsBalanceBefore` number — The customer's points balance before the transaction occurred.
    - `pointsBalanceAfter` number — The customer's points balance after the transaction is completed.
    - `achievementType` string — Type of achievement earned during the transaction, if applicable.
    - `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.
    - `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.
  - `count` number — The total number of transactions on the current page.
  - `hasMore` boolean — Indicating whether there are additional transactions to be fetched beyond the current page.

---

[API](https://skmtc.net/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.net/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gameballers/gameball-api/versions/2e4a8bfe2291/schema)