API Portal

🧭 Cashier API Portal

Welcome to the Cashier API Portal β€” a complete documentation and testing interface for all cashier and manager API endpoints. Here you can explore, test, and understand how each part of the cashier system communicates with the backend.

ℹ️ How It Works
  • Each section in the sidebar corresponds to a specific API endpoint.
  • Every guide explains the HTTP method, URL, request parameters, and sample responses.
  • All authenticated endpoints require a valid Bearer Token obtained via the Login endpoint.
  • You can use cURL examples from each page to directly test requests in Postman or your app.

⚠️ Important: Always Check the success Flag

Every API response includes a boolean success field that indicates whether the request completed successfully. Always check this value before processing data in your application:

{
  "success": true,
  "data": [...]
}

If success = false, the response will include a message field with the error description.

{
  "success": false,
  "message": "Unable to load cash report"
}
πŸ“š Available Guides
  • πŸ” Login β€” Authenticate and obtain your access token.
  • πŸ‘₯ Users β€” Retrieve all player accounts linked to your shop.
  • πŸ’° Cash Report β€” Get full cashier or shop-level cash flow summary.
  • πŸ‘€ User Cash Report β€” Detailed per-player cash and transaction data.
  • πŸ’³ Credits Action β€” Perform deposit, withdrawal or bonus actions.
  • 🧾 User Transactions β€” List or filter individual player transactions.
  • βš™οΈ Other tools β€” bonus cancel, panic mode, update password, view logs, and user history.

All endpoints return structured JSON responses. Use them in your frontend, backend integrations, or Postman collections.