Debit

Your integration layer uses this endpoint to deduct an amount from the player’s wallet balance during a game session. This process is crucial as it manages the player’s funds when placing bets, ensuring that the transaction is properly tracked and securely processed.

When a player places a bet, your integration layer sends parameters like player_id, site_id, token, and additional transaction-related fields, deducting the specified amount from the player’s balance. The endpoint ensures the validity of the provided token and other data before processing the debit, maintaining the integrity of the player’s session and wallet.

Key Points link

• Purpose: To deduct a specified amount from the player’s balance during gameplay.
• Process: Validates the provided token and player information, then processes the debit transaction with detailed tracking.
• Security: Ensures that only authorized and valid requests are processed, safeguarding the player’s funds.

This endpoint is essential for managing bets and other financial actions during game sessions, providing secure and accurate balance adjustments linked to specific game rounds and transactions.

Note

This endpoint requires HTTP/2 for optimal performance, it is recommended to send your requests using HTTP/2. The HTTP/2 protocol enables multiplexing, allowing multiple requests and responses to be sent simultaneously over a single TCP connection. This reduces latency and improves efficiency, especially in high-throughput scenarios like gaming platforms. Ensure your integration client supports HTTP/2 to achieve faster response times and better scalability.

POST /api/wallet/debit link

Request Headers:

• Content-Type - application/json
• Accept - application/json
• Authorization - Calculation
• X-Request-Signature - Calculation

JSON Parameters:

• token (string) - The token provided via query parameters in the launch URL.
• player_id (unsigned big integer) - The Integrator player ID provided via query parameters in the launch URL.
• site_id (unsigned big integer) - The Integrator site ID provided via query parameters in the launch URL.
• provider_id (unsigned big integer) - The provider ID assigned by us for the provider you are integrating.
• game_id (string) - The game ID you provided to us.
• currency (string) - The currency provided via query parameters in the launch URL.
• amount (unsigned float) - The amount to be deducted from the player’s balance. This value specifies the bet or transaction amount associated with the current gameplay action.
• round_id (string) - A unique identifier for the game round associated with the debit transaction. This ID links the transaction to the specific gameplay instance. We do not accept multiple debits within a single round. If your game type sends more than one debit in a round, please use the debit transaction ID as the round ID instead. Maximum length: 36 characters.
• transaction_id (string) - A unique identifier for the specific transaction, ensuring that each debit action is uniquely tracked and logged. Maximum length: 36 characters.
• round_closed (boolean) - A flag indicating whether the current game round is closed. This helps in determining the status and finality of the debit action.

Response Headers:

• Content-Type - application/json

Response JSON Object:

• status (boolean) - Indicates whether the request was successful or not. A value of true means the operation was successful, while false indicates an error or failure.
• code (unsigned big integer) - A unique code representing the result of the request.
• message (string) - A human-readable message providing additional information about the status of the request. This message can include details about errors or successes.
• request_id (uuid) - A unique identifier for the specific request, used for tracking and logging purposes. It helps in tracing the request throughout the system for debugging or support.
• token (string) - The same token that was provided in the request, returned for reference and validation purposes. This ensures the response corresponds to the correct session and player.
• player_id (unsigned big integer) - The player ID associated with the debit request, confirming the identity of the player whose balance is being adjusted.
• game_id (unsigned big integer) - The game ID represents the internal game ID in our system.
• site_id (unsigned big integer) - The site ID associated with the request, linking the transaction to a specific platform or environment. This ensures that all operations are correctly attributed to the appropriate site where the player is accessing the service.
• provider_id (unsigned big integer) - The provider ID as specified in the request, identifying the provider associated with the game session.
• balance (unsigned float) - The player’s current wallet balance after the debit operation, reflecting the latest available funds in the account.

Status Codes:

• The HTTP status code returned by the API corresponds to the code value included in the response.

Request:

  POST /api/wallet/debit HTTP/2
Host: environment
Authorization: Basic <encoded_credentials>
X-Request-Signature: <calculated-signature>
Content-Type: application/json
Accept: application/json

{
  "token": "3dc8fe01-2018-486e-9632-35aef21028a5",
  "player_id": 1,
  "site_id": 1,
  "provider_id": 1,
  "game_id": "example",
  "currency": "EUR",
  "amount": 50.50,
  "round_id": "ebe18296b1d7d42e1d2181d43a1c9cb5",
  "transaction_id": "73aa34d0851df1ebde09b82506da4329",
  "round_closed": false
}
  

Success Response:

  HTTP/2 200 OK
Content-Type: application/json

{
  "status": true,
  "code": 1,
  "message": "",
  "request_id": "89aac521-7a56-4ad1-8310-1ed2bbf9e55d",
  "token": "3dc8fe01-2018-486e-9632-35aef21028a5",
  "player_id": 1,
  "game_id": "example",
  "site_id": 1,
  "provider_id": 1,
  "balance": 19575.50
}
  

Failed Response:

  HTTP/2 500 Internal Server Error
Content-Type: application/json

{
  "status": false,
  "code": 2,
  "message": "An unknown error has occurred.",
  "request_id": "4d5a42b3-62ec-40cb-b5e9-b338f194ce60"
}
  

Note

If the parameter round_closed has been set to true in the request, no further actions can be performed on the same round. This restriction is in place to ensure the integrity and consistency of game sessions, preventing any changes or transactions after a round has been closed. Once a round is marked as closed, it is considered finalized, and all related transactions are locked. Any attempt to perform actions such as debit, rollback, or credit on a closed round will result in an error response, maintaining the integrity of the gameplay and preventing unauthorized modifications.

Rollback Scenarios link

If you receive any of the following response codes in the response JSON object, your integration layer must rollback the transaction to ensure consistency:

These errors indicate an issue that may have affected the transaction, requiring a rollback to maintain accurate financial records and prevent incorrect balance adjustments.