Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 4.35 KB

api-surface.md

File metadata and controls

64 lines (43 loc) · 4.35 KB

Public API surface

The AG Game API V5.0.0 public documentation groups 17 endpoints by operational responsibility. This orientation map helps an integration team identify the systems and owners involved, then connect them to the implementation package.

Last reviewed: 2026-08-16

Public reference boundary

The public website provides this capability catalog together with the signing method, representative fields, and redacted examples for technical evaluation. Approved endpoint paths and the HMAC algorithm do not make a signing key public: security depends on keeping the key secret and enforcing the protocol on the server. The higher-risk fund-recovery and merchant-configuration capabilities disclose their purpose publicly, while their exact paths are supplied only in the controlled implementation package.

This public material is not the complete production protocol and contains no usable credentials. The real Base URL, merchant credentials, complete field constraints, final callback list, and production configuration are supplied only through the controlled project process. Do not send real player or transaction data through public issues or contact channels.

Game catalog and sessions

The provider catalog currently organizes PGSoft, Pragmatic, Evoplay, CP Games, WG Games, JILI, TADA, JDB, FC, BG, and HSD through the unified discovery and game-session flow. See the game provider directory and complete game catalog mapping.

Method Path Integration purpose
POST /game/v5/providers List the game providers available to the agreed integration scope.
POST /game/v5/categories List game categories used for content discovery.
POST /game/v5/games List games with pagination.
POST /game/v5/game/url Create a player game session and obtain a launch URL.
POST /game/v5/player/force/logout End a player game session through the configured workflow.

Project onboarding turns the catalog into a delivery content set aligned with the platform rollout plan.

Single-wallet callbacks

Method Path Integration purpose
POST {MERCHANT-URL}/wallet/balance Query the balance maintained by the merchant platform.
POST {MERCHANT-URL}/player/info Query player information required by the agreed callback flow.
POST {MERCHANT-URL}/wallet/bet Notify the merchant of a bet operation.
POST {MERCHANT-URL}/wallet/win Notify the merchant of settlement or combined bet-settlement data.
POST {MERCHANT-URL}/wallet/cancel Notify the merchant that an order is cancelled.

The project technical mapping defines the callback set and response behavior used by the selected wallet workflow.

Transfer wallet

Method Path Integration purpose
POST /game/v5/cash/deposit Transfer funds into a player game wallet.
POST /game/v5/cash/withdraw Transfer funds out of a player game wallet.
POST /game/v5/cash/balance Query the player game-wallet balance.
POST /game/v5/cash/transaction Query wallet transaction records with pagination.
POST {CONTROLLED-PATH:FUND-RECOVERY} Recover all funds from a player game wallet through the configured recovery flow.

Money-moving requests require a unique business identity, a defined retry policy, and a reconciliation path. After an HTTP timeout, the status query and reconciliation path determine the original transfer outcome.

Records and merchant

Method Path Integration purpose
POST /game/v5/game/record Query game records with pagination.
POST {CONTROLLED-PATH:MERCHANT-CONFIGURATION} Query current merchant configuration and wallet information.

Record queries complement the platform's accounting, monitoring, and audit records with operational lookup and reconciliation data.

Implementation package

The project implementation package adds environment hosts, credentials, allowlists, complete field schemas, the final callback mapping, and production configuration to the official API documentation. Signing keys remain in the designated server-side secret store and are not part of this repository.

Next: choose the responsibility model in Single wallet and transfer wallet.