Order Transactions

Retrieve transactional details linked to an order (rewards, refunds, redemptions).

Security: Provide both apikey and secretkey headers.

Authorizations

apikey

string

header

required

Path Parameters

orderId

string

required

Unique identifier for the order, which is case-sensitive. It is used to reference and retrieve the order's transactions accurately.

Response

200 - application/json

Order transactions retrieved successfully

transactions

object[]

List of transactions associated with the order. Example: If a customer places an order and redeems points, the transactions array will contain both the cashback reward transaction and the redemption transaction.

Show child attributes

transactions.transactionDate

string<date-time>

The date and time when the transaction occurred.

Example:

"2024-10-16T08:13:29.29"

transactions.gameballTransactionId

integer

Unique identifier for the transaction in the Gameball system.

Example:

11034754

transactions.transactionType

enum<string>

Type of transaction. Possible values include: AchievementReward - Captured when a customer reaches a VIP tier, participates in a reward campaign, or makes a referral. PaymentReward - Recorded for rewarding a customer with points for every placed order. Refund - Captured when points redeemed from a refunded order are returned to the customer. Redemption - Recorded whenever a customer redeems their points for rewards. Expiry - Captured when a customer's points expire, indicating a reduction in their total points. Cancel - Recorded when a customer cancels an order, leading to the deduction of rewarded points. Migration - Captured during updates or migrations of customer data via a CSV file, reflecting added or deducted points. ManualAccumulation - Recorded for points that are manually added to a customer's balance. DiscountCode - Captured when a customer creates a coupon code. ManualDeduction - Recorded for points manually removed from a customer's balance. ManualReward - Similar to AchievementReward, but specifically for manually awarding achievements to a customer.

Available options:

AchievementReward,

PaymentReward,

Refund,

Redemption,

Expiry,

Cancel,

Migration,

ManualAccumulation,

DiscountCode,

ManualDeduction,

ManualReward

Example:

"PaymentReward"

transactions.amount

number

The monetary value involved in the transaction.

Example:

250.75

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:

"ORD12345"

transactions.equivalentPoints

number

The points equivalent to the monetary value of the transaction.

Example:

192

count

integer

Total number of transactions associated with the order.

Example:

1

API documentation

Webhooks

Authorizations

Path Parameters

Response