Report API

The Report API provides endpoints for:

• Retrieving gaming activity based on various filters.

• Checking a player’s transfer history (available only for Transfer Wallet accounts).

All following requests are passed from the operator to VeliGames using the HTTP POST method with the content type application/json. The signature parameter in the header is mandatory for all requests.

See also

Authentication

API Method: List Gaming Activity

This API method returns all successfully processed transactions (bet, win, cancel) that affected player’s balance.

Tip

If a transaction was cancelled, there will be 2 rows:

• The original transaction (BET, WIN)

• Action type CANCEL with appropriate refActionType (BET, WIN) and refTransactionId (what was cancelled)

Rarely, Bets can have partial refunds, (CANCEL_BET only). in this case cancel amount will be different.

Path:

https://VELIGAMES_API_URL/report-api/public/gaming-activity

HTTP Method:

POST

Request body

Parameter	Type	Description
fromDate	Date (YYYY-MM-DD)	The start date for the request period. (>=)
toDate	Date (YYYY-MM-DD)	The end date for the request period. (<=)
providerId	string (optional)	The identifier of the game provider.
roundId	string (optional)	The identifier of the game round.
currencies	array of strings (optional)	A list of currency codes to filter by. (max: 20) [1]
gameIds	array of strings (optional)	A list of game identifiers to filter by. (max: 20)
excludeFreeWin	boolean (optional)	Indicates whether to exclude free wins in the data.
page	integer (optional, default: 1)	The page number for paginated results. Must be at least 1.
size	integer (optional, default: 100)	The number of results per page (max: 1000).
playerIds	array of strings (optional)	A list of player ids to filter by. (max: 20) [3]
brandId	string	The identifier of the casino brand [2]

The response contains paginated transactions.

An example of using gaming-activity API method

curl -X 'POST' \
  'https://VELIGAMES_API_URL/report-api/public/gaming-activity' \
  -H 'Content-Type: application/json' \
  -H 'signature: OPERATOR_ID:tapm5+EvNZ5d...0GCfUspxw==' \
  -d '{
        "fromDate": "2024-03-01",
        "toDate": "2024-03-05",
        "providerId": "provider123",
        "currencies": ["INR"],
        "brandId": "brandX",
        "gameIds": ["game123", "game2"],
        "page": 1,
        "size": 100,
        "playerIds": ["2cafb095...7f05", "9b8a2cd4...1a3e"]
      }'
Copy code

JSON Response

The response includes a list of transactions under the items parameter. Information about the pagination is found in the meta parameter.

{
   "items": [
        {
            "transactionId": "TRX-uuid1",
            "sessionId": "session789",
            "roundId": "hd1982894",
            "correlationId": "correlation234",
            "roundType": "BET_CRASH",
            "actionType": "BET",
            "providerId": "provider123",
            "brandId": "brandX",
            "playerId": "2cafb095...7f05",
            "gameId": "game123",
            "amount": 981.56,
            "currency": "INR",
            "createdAt": "2024-03-05T12:34:56Z",
            "amountEur": 10.5,
            "amountUsd": 11.2
        },
        {
            "transactionId": "TRX-uuid2",
            "sessionId": "session789",
            "roundId": "hd1982894",
            "correlationId": "correlation234",
            "roundType": "CANCEL_TRANSACTION",
            "actionType": "CANCEL",
            "providerId": "provider123",
            "brandId": "brandX",
            "playerId": "2cafb095...7f05",
            "gameId": "game123",
            "amount": 981.56,
            "currency": "INR",
            "createdAt": "2024-03-05T12:34:57Z",
            "refTransactionId": "TRX-uuid1",
            "refRoundType": "CANCEL",
            "refActionType": "BET",
            "amountEur": 10.5,
            "amountUsd": 11.2
        }
   ],
   "meta": {
        "totalItems": 2,
        "itemCount": 2,
        "itemsPerPage": 100,
        "totalPages": 1,
        "currentPage": 1
   }
}
Copy code

The items parameter contains transaction object with following fields:

Parameter	Type	Description
transactionId	string	The unique identifier of the transaction by VeliGames.
sessionId	string	The identifier of the session.
roundId	string	The identifier of the round.
correlationId	string	The correlation id (betId) for tracking related transactions.
roundType	string	The type of the round.
actionType	string	The type of action taken. (BET, WIN, CANCEL)
providerId	string	The identifier of the game provider.
brandId	string	The identifier of the casino brand [2].
playerId	string	The identifier of the player [3].
gameId	string	The identifier of the game.
amount	decimal	The transaction amount.
currency	string	The currency code [1].
createdAt	string (ISO 8601)	The timestamp when the transaction was created.
amountEur	decimal	The equivalent transaction amount in EUR.
amountUsd	decimal	The equivalent transaction amount in USD.
refTransactionId	string (If actionType=CANCEL)	The reference transaction ID of the original cancelled transaction.
refRoundType	string (If actionType=CANCEL)	The round type of the original cancelled transaction.
refActionType	string (If actionType=CANCEL)	The action type of the original cancelled transaction.

Details about the pagination under meta contain:

Param	Type	Description
totalItems	number	The total number of items in the collection that matches the request.
itemCount	number	The number of items returned in this particular response
itemsPerPage	number	The maximum number of items from the data set that may fit in a page.
totalPages	number	The total number of pages required to deliver the whole collection.
currentPage	number	The current page number for this particular response.

Errors

An example of an error response

{"error":"BAD_REQUEST", "details": { "fromDate": "Can not be empty value" }}
Copy code

Error	Status code	Description
UNKNOWN_ERROR	500	A generic error: an internal server error, which can be retried
BAD_REQUEST	400	Missing/invalid parameters
UNAUTHORIZED	401	Invalid signature

API Method: Huge Wins

Path:

https://VELIGAMES_API_URL/report-api/public/gaming-activity/huge-wins

HTTP Method:

POST

Request body

This API method returns huge wins of a brand based on configuration. Default is equivalent of 10000 USD of win or 100x than original bet. Defaults can be slightly changed upon brand request.

JSON Response

The response contains paginated transactions.

An example of using huge-wins API method

curl -X 'POST' \
  'https://VELIGAMES_API_URL/report-api/public/gaming-activity/huge-wins' \
  -H 'Content-Type: application/json' \
  -H 'signature: OPERATOR_ID:tapm5+EvNZ5d...0GCfUspxw==' \
  -d '{
        "fromDate": "2024-03-01",
        "toDate": "2024-03-05",
        "providerId": "provider123",
        "currencies": ["INR"],
        "brandId": "brandX",
        "gameIds": ["game123", "game2"]
      }'
Copy code

JSON Response

The response includes a list of transactions under the items parameter. Information about the pagination is found in the meta parameter.

{
   "items": [
        {
           "betTransactionId": "TRX-uuid1",
           "winTransactionId": "TRX-uuid2",
           "currency": "INR",
           "gameId": "game123",
           "betAmount": 981.56,
           "winAmount": 981000.56,
           "betAmountUsd": 11.48,
           "winAmountUsd": 11469,
           "providerId": "provider123",
           "playerId": "2cafb095...7f05",
           "roundId": "hd1982894",
           "correlationId": "correlation234",
           "brandId": "brandX",
           "operatorId": "operatorX",
           "createdAt": "2024-03-05T12:34:57Z",
           "reason": "11469 > 10000"
        }
   ],
   "meta": {
        "totalItems": 1,
        "itemCount": 1,
        "itemsPerPage": 100,
        "totalPages": 1,
        "currentPage": 1
   }
}
Copy code

Details about the pagination under meta contain:

Param	Type	Description
totalItems	number	The total number of items in the collection that matches the request.
itemCount	number	The number of items returned in this particular response
itemsPerPage	number	The maximum number of items from the data set that may fit in a page.
totalPages	number	The total number of pages required to deliver the whole collection.
currentPage	number	The current page number for this particular response.

Errors

An example of an error response

{"error":"BAD_REQUEST", "details": { "fromDate": "Can not be empty value" }}
Copy code

Error	Status code	Description
UNKNOWN_ERROR	500	A generic error: an internal server error, which can be retried
BAD_REQUEST	400	Missing/invalid parameters
UNAUTHORIZED	401	Invalid signature

API Method: Credit Balances

This API method returns current credits per activated currency on brand with corresponding alert threshold set by the brand. (Applies only to accounts that use credit limits)

Path:

https://VELIGAMES_API_URL/report-api/public/credit/balances

HTTP Method:

POST

Request body

The response contains balances per currency.

An example of using transfer-wallet API method

curl -X 'POST' \
  'https://VELIGAMES_API_URL/report-api/public/credit/balances' \
  -H 'Content-Type: application/json' \
  -H 'signature: OPERATOR_ID:tapm5+EvNZ5d...0GCfUspxw==' \
  -d '{
        "brandId": "yourBrand"
      }'
Copy code

JSON Response

{
    "credits": [
        {
            "currency": "ETB",
            "balance": 100000,
            "threshold": 100000
        }
    ]
}
Copy code

The credits parameter contains object with following fields:

Parameter	Type	Description
currency	string	Currency Identifier
balance	number	Current balance in corresponding currency
threshold	number	Balance threshold amount below which brand should trigger alerts.

Errors

An example of an error response

{"error":"BAD_REQUEST", "details": { "brandId": "Can not be empty value" }}
Copy code

Error	Status code	Description
UNKNOWN_ERROR	500	A generic error: an internal server error. Contact support if is not resolved.
BAD_REQUEST	400	Missing/invalid parameters
UNAUTHORIZED	401	Invalid signature

API Method: List Transfer Wallet History

This API method returns all successfully processed transactions in transfer wallet api (WITHDRAW, DEPOSIT) that affected player’s balance. (Transfer Wallet Only)

Path:

https://VELIGAMES_API_URL/report-api/public/transfer-wallet/history

HTTP Method:

POST

Request body

Parameter	Type	Description
fromDate	Date (YYYY-MM-DD)	The start date for the request period. (>=)
toDate	Date (YYYY-MM-DD)	The end date for the request period. (<=)
currencies	array of strings (optional)	A list of currency codes to filter by. (max: 20) [1]
playerId	string	Player id to filter by. [3]
brandId	string	The identifier of the casino brand [2]
page	integer (optional, default: 1)	The page number for paginated results. Must be at least 1.
size	integer (optional, default: 100)	The number of results per page (max: 1000).

The response contains paginated transactions.

An example of using transfer-wallet API method

curl -X 'POST' \
  'https://VELIGAMES_API_URL/report-api/public/transfer-wallet/history' \
  -H 'Content-Type: application/json' \
  -H 'signature: OPERATOR_ID:tapm5+EvNZ5d...0GCfUspxw==' \
  -d '{
        "fromDate": "2025-02-10",
        "toDate": "2025-02-29",
        "brandId": "yourBrand",
        "playerId": "TL-7d3fda31-2a41-475e-a80b-b0dd3bd2295a",
        "page": 1,
        "size": 50
      }'
Copy code

JSON Response

The response includes a list of transactions under the items parameter. Information about the pagination is found in the meta parameter.

{
   "items": [
        {
         "transactionId": "521b3a47-4b25-452a-979d-0eae92819f3c",
         "transactionType": "TRANSFER",
         "actionType": "DEPOSIT",
         "amount": 1000,
         "currency": "USD",
         "timestamp": "2025-02-28T14:45:37.672Z",
         "extTransactionId": "extTransactionId1",
         "balanceAfter": 2000
     },
     {
         "transactionId": "31a0e2a7-fb89-43a5-a651-05c33c4f7ed0",
         "transactionType": "GA",
         "actionType": "WITHDRAW",
         "amount": 500,
         "currency": "USD",
         "timestamp": "2025-02-28T14:45:29.597Z",
         "extTransactionId": "extTransactionId2",
         "balanceAfter": 1500
     }
   ],
   "meta": {
     "currentPage": 1,
     "itemCount": 2,
     "itemsPerPage": 2,
     "totalItems": 19,
     "totalPages": 10
   }
}
Copy code

The items parameter contains transaction object with following fields:

Parameter	Type	Description
transactionId	string	The unique identifier of the transaction by VeliGames.
transactionType	string	type of transaction. TRANSFER or GA (Gaming Activity)
actionType	string	The type of action taken. DEPOSIT or WITHDRAW
amount	decimal	The transaction amount.
currency	string	The currency code [1].
timestamp	string (ISO 8601)	The timestamp when the transaction was created.
extTransactionId	string	The external transaction ID of the transaction.
balanceAfter	decimal	Balance after the transaction.

Details about the pagination under meta contain:

Param	Type	Description
totalItems	number	The total number of items in the collection that matches the request.
itemCount	number	The number of items returned in this particular response
itemsPerPage	number	The maximum number of items from the data set that may fit in a page.
totalPages	number	The total number of pages required to deliver the whole collection.
currentPage	number	The current page number for this particular response.

Footnotes

[1] (1,2,3,4)

Currency codes comply with ISO 4217: EUR, USD and so on.

[2] (1,2,3,4)

In some configurations, the brandId parameter appears as agent

[3] (1,2,3)

In some configurations, the playerId parameter appears as member