> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gameball.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Order Transactions

> Retrieve reward, refund, and redemption transactions for a specific order.

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

<Info>
  Security: Provide both `apikey` and `secretkey` headers.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/orders/{orderId}/transactions
openapi: 3.1.0
info:
  title: Gameball API
  description: >-
    Gameball REST API v4.0 - Complete API reference for integrating loyalty,
    gamification, and customer engagement features
  version: 4.0.0
servers:
  - url: https://api.gameball.co
security:
  - bearerAuth: []
paths:
  /api/v4.0/integrations/orders/{orderId}/transactions:
    get:
      tags:
        - Orders
      summary: Order Transactions
      description: >-
        This API retrieves the transactional details for a specified order in
        Gameball, identified by `orderId`. It includes information on rewards,
        refunds, and equivalent points, giving a detailed view of the financial
        activities associated with the order.


        **Security:** Requires both `apikey` and `secretkey` headers.
      operationId: getOrderTransactions
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
          description: >-
            Unique identifier for the order, which is case-sensitive. It is used
            to reference and retrieve the order's transactions accurately.
          example: ORD12345
      responses:
        '200':
          description: Order transactions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactions:
                    type: array
                    description: >-
                      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.
                    items:
                      type: object
                      properties:
                        transactionDate:
                          type: string
                          format: date-time
                          description: The date and time when the transaction occurred.
                          example: '2024-10-16T08:13:29.29'
                        gameballTransactionId:
                          type: integer
                          description: >-
                            Unique identifier for the transaction in the
                            Gameball system.
                          example: 11034754
                        transactionType:
                          type: string
                          description: >-
                            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. **Payment** - Recorded when a
                            customer makes a payment for an order. **Refund** -
                            Captured when points redeemed from a refunded order
                            are returned to the customer. **PartialRefund** -
                            Captured when a partial refund is processed,
                            returning a portion of redeemed points 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.
                          enum:
                            - AchievementReward
                            - PaymentReward
                            - Payment
                            - Refund
                            - PartialRefund
                            - Redemption
                            - Expiry
                            - Cancel
                            - Migration
                            - ManualAccumulation
                            - DiscountCode
                            - ManualDeduction
                            - ManualReward
                          example: PaymentReward
                        amount:
                          type: number
                          description: The monetary value involved in the transaction.
                          example: 250.75
                        transactionId:
                          type: string
                          description: >-
                            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
                        equivalentPoints:
                          type: number
                          description: >-
                            The points equivalent to the monetary value of the
                            transaction.
                          example: 192
                  count:
                    type: integer
                    description: Total number of transactions associated with the order.
                    example: 1
      security:
        - apiKey: []
          secretKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````