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":[]
}

Last updated