Batches 👑
Batch operations are used to make multiple one type operations with one request.
Batch operations are used to make multiple one-type operations with one request.
This endpoint is only available for our GURU customers only 👑
Currently, the following operations can be executed in batches :
- Bulk Cashback
- Bulk Redeem
- Bulk Balance Inquiry
Each batch is limited to a max of 1000 entries per batch.
Using the batch API is simple as it provides unified interfaces to execute any of the above supported operations. It can be used to run async batches and track them in your system.
To start a batch operation, you need to start a batch request via the Start Batch API. You can then keep checking the status of a batch operation started via its Batch ID. The status of the batch can be one of the following
Status | Description |
pending | Batch is received but not started |
inProgress | Batch is in progress |
finished | All batch operations are finished |
stopped | Batch stopped |
Once the batch status is finished, you will be able to check the batch operation outcome including total processed, total failed, and return body object if any.

Type | Description | Endpoint |
POST | /integrations/batch | |
GET | /integrations/batch/:batchId | |
DELETE | /integrations/batch/:batchId |
https://api.gameball.co/api/v3.0/integrations/batch
Attribute | Type | Required | Description |
APIKey | string | Yes | Client API key |
SecretKey | string | Yes | Client Secret key\transaction key |
Attribute | Type | Required | Description |
method | string | Yes | The HTTP method to use for the operation. Possible values: "GET", "POST", "PUT", or "PATCH". |
operation | string | Yes | Name of the operation to be performed. Possible values are cashback redeem balance |
params | integer | No | Optional request query parameters. |
body | string | Yes | An object with JSON body to use with the request. Each operation has its own body |
{
"method":"POST",
"operation":"cashback",
"params":{
"name":"mike"
},
"body":{}
}
Parameter | Type | Description |
batchId | string | Batch id to be used to get the status of the created batch |
cURL
curl -X POST -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703'
-d '{
"method":"POST",
"operation":"cashback",
"params":{
"name":"mike"
},
"body":{}
}'
-v -i 'https://api.gameball.co/api/v3.0/integrations/batch'
https://api.gameball.co/api/v3.0/integrations/batch/:batchId
Attribute | Type | Required | Description |
APIKey | string | Yes | Client API key |
SecretKey | string | Yes | Client Secret key\transaction key |
Parameter | Type | Required | Description |
batchId | string | Yes | Batch operation ID |
Attribute | Type | Description |
method | string | The HTTP method to use for the operation. Possible values: "GET", "POST", "PUT", or "PATCH". |
operation | string | Name of the operation to be performed. Possible values are cashback redeem balance |
errorCount | integer | Items with errors in batch count |
totalCount | integer | Items in batch count |
finishedCount | integer | Processed items in batch count |
startedAt | datetime | Batch operations start time in UTC. format. Example: 2017-05-30T15:14:22Z |
createdAt | datetime | Batch operations creation time in UTC. format. Example: 2017-05-30T15:14:22Z |
status | string | Batch operation status inProgress pending finished stopped |
response | object | Result of operation (JSON object) |
{
"method":"POST",
"operation":"cashback",
"errorCount":0,
"totalCount":100,
"finishedCount":60,
"startedAt":"2012-12-30 16:50:11",
"createdAt":"2012-12-30 16:50:11",
"status":"processing",
"response":{}
}
cURL
curl -X GET -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703'
-v -i 'https://api.gameball.co/api/v3.0/integrations/batch/213'
https://api.gameball.co/api/v3.0/integrations/batch/:batchId
Attribute | Type | Required | Description |
APIKey | string | Yes | Client API key |
SecretKey | string | Yes | Client Secret key\transaction key |
Parameter | Type | Required | Description |
batchId | string | Yes | Batch operation ID |
cURL
curl -X DELETE -H 'apiKey: 807b041b7d35425988e354e1f6bce186' \
-H 'secretKey: klmb041b7d354259l3u4ft35e1q2r3703'
-v -i 'https://api.gameball.co/api/v3.0/integrations/batch/213'
Last modified 2yr ago