Gameball Developers Guide
v3.0
v3.0
  • Introduction
  • What's New in V3.0
  • Installing Gameball
    • Web
      • Show Gameball Customer Widget
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Go-Live Checklist
    • iOS
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • Android
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
    • React Native
      • Getting Started
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
      • Go-Live Checklist
      • Migration from v1 to v2
    • Flutter
      • Getting Started
      • Initialize Gameball SDK
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Referrals
      • Go-Live Checklist
    • Generic Mobile App
      • Initialize Gameball Customer Profile
      • Track Customer Events
      • Track Orders & Cashback Reward
      • Integrate Redemption
      • Track Referrals
      • Push Notifications
    • Retail & Modern POS
      • Initialize Gameball Customer Profile
      • Track Orders & Cashback Reward
      • Track Refunds
      • Enable Redemption
        • Prepare POS for Redemption
        • Using Virtual ID
          • Using Virtual Card
  • REST API
    • Overview
      • Server-Side SDKs
    • Authentication
    • API Reference
      • Customer
      • Event
      • Transactions
      • Order
      • Coupons
      • Leaderboard 👑
      • Notifications 👑
      • Configurations 👑
      • Batches 👑
        • Batch Operations Data
      • OTP
      • Partner 🤝
        • Client 🤝
        • Redemption Rule 🤝
        • Cashback Rule 🤝
    • Webhooks
      • Notifications Webhook
      • Customer Profile Webhook
    • Errors
    • Object Reference
  • Tutorials
    • Build Custom UI Elements 👑
      • Display Reward Campaign Progress
      • Show VIP Tiers
      • Show Customer Points Balance
      • Build Leaderboards
      • Show Notifications Inbox
      • Adapt UI to Configurations
      • Advanced UI Techniques
        • Increase Sales with Cashback UI Elements
        • Derive Engagement with Rewards Campaigns UI Elements
    • Tracking Customer Events
    • Build your Own Notification System
    • Checkout Integration Example
    • Redemption Integration Options
      • Redeem with coupon system
        • Integrate your coupon system
          • Example using e-commerce platform(WooCommerce)
          • Example using a custom coupon system
        • Build couponing experience
          • Using Gameball widget
          • Build custom experience
            • Showing customers available points
            • Allowing customers to create coupons
            • Apply the discount code to your cart
        • Coupon integration reference
      • Redeem with direct debt
        • Get customers points balance
        • Redeem customer points
  • Third Party Integrations
    • Segment Integration
Powered by GitBook
On this page
  • Bulk Balance Inquiry
  • Batch body Object
  • Batch response Object
  • Bulk Cashback
  • Batch body Object
  • Batch response Object
  • Bulk Redeem
  • Batch body Object
  • Batch response Object
  1. REST API
  2. API Reference
  3. Batches 👑

Batch Operations Data

Every supported batch operation

  • Bulk Balance Inquiry

  • Bulk Cashback

  • Bulk Redeem

expects a different body object and returns a different response object within the create batch request or get batch request.

Bulk Balance Inquiry

Batch body Object

{
    "playerUniqueIds": ["5024357384366","4024357384355","2124357384388"]
}

Complete balance inquiry batch example

{
   "method":"POST",
   "operation":"balance",
   "params":{},
   "body":{
    "playerUniqueIds": ["5024357384366","4024357384355","2124357384388"]
   }
}

Batch response Object

{
   "successful":[
      {
         "playerUniqueId":"5024357384366",
         "pointsBalance":2000,
         "pointsValue":6000.0,
         "currency":"USD",
         "pointsName":"Points"
      },
      {
         "playerUniqueId":"4024357384355",
         "pointsBalance":3000,
         "pointsValue":9000.0,
         "currency":"USD",
         "pointsName":"Points"
      }
   ],
   "failed":[
      {
         "playerUniqueId":"2124357384388",
         "message":"No Player with this External ID"
      }
   ]
}

Bulk Cashback

Batch body Object

[
   {
      "playerUniqueId":"string",
      "transactionId":"string",
      "transactionTime":"2021-07-25T14:22:42.097Z",
      "amount":100,
      "merchant":{
         "uniqueId":"string",
         "name":"string",
         "branch":{
            "uniqueId":"string",
            "name":"string"
         }
      }
   }
]

Complete cashback batch example

{
   "method":"POST",
   "operation":"cashback",
   "params":{},
   "body":[
      {
         "playerUniqueId":"2124357384388",
         "transactionId":"231F454BB",
         "transactionTime":"2021-07-25T14:22:42.097Z",
         "amount":100      
      }
   ]
}

Batch response Object

{
   "successful":[
      {
         "playerUniqueId":"2124357384388",
         "amount":"100",
         "points":"1000",
         "gameballTransactionId":"27535"
      }
   ],
   "failed":[]
}

Bulk Redeem

Batch body Object

[
   {
      "playerUniqueId":"2124357384388",
      "transactionId":"231F454BB",
      "transactionTime":"2021-07-25T14:40:29.121Z",
      "redeemedAmount":"200",
      "holdReference":null
   }
]

Complete redeem batch example

{
   "method":"POST",
   "operation":"redeem",
   "params":{},
   "body":[
      {
         "playerUniqueId":"2124357384388",
         "transactionId":"231F454BB",
         "transactionTime":"2021-07-25T14:40:29.121Z",
         "redeemedAmount":"200",
         "holdReference":null
      }
   ]
}

Batch response Object

{
   "successful":[
      {
         "playerUniqueId":"2124357384388",
         "GameballTransactionId": "AA1F23419",
         "RedeemedPoints": "200"
      }
   ],
   "failed":[]
}

PreviousBatches 👑NextOTP

Last updated 1 year ago