Your integration layer uses this endpoint to check the current status of a specific transaction during a game session. This process is important for verifying the state of a transaction, such as confirming if a credit, debit, or rollback operation was successful, pending, or failed.

When a status check is required, your integration layer sends parameters like player_id, site_id, token, and other transaction-related fields. It provides the current status of the specified transaction, ensuring the player and the system have up-to-date information about the transaction state.

Key Points

  • Purpose: To verify the status of a specific transaction, including credit, debit, or rollback actions.
  • Process: Validates the provided token and player information, then retrieves the status of the specified transaction with detailed tracking.
  • Security: Ensures that only authorized and valid requests are processed, safeguarding the player’s funds and providing accurate transaction information.

This endpoint is essential for tracking the status of financial actions during game sessions, providing secure and reliable information about specific 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/status

Request Headers:

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 associated with the transaction. This value specifies the amount being checked, matching the original action (debit, credit, or rollback).
  • round_id (string) - A unique identifier for the game round associated with the transaction. This ID links the status check to the specific gameplay instance. Maximum length: 36 characters.
  • transaction_id (string) - A unique identifier for the transaction being checked, ensuring that each action is uniquely tracked and logged. Maximum length: 36 characters.
  • action (string) - The type of transaction being checked. This field can take values such as debit, credit, or rollback.

Response Headers:

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 status request, confirming the identity of the player whose transaction is being checked.
  • 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 rollback 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/status 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": "d47ac10b-58cc-4372-a567-0e02b2c3d479",
  "action": "debit"
}

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"
}